Merge pull request #88 from CenterForTheBuiltEnvironment/development

docs

README.rst

@@ -63,7 +63,7 @@ Overview
 
 Package to calculate several thermal comfort indices (e.g. PMV, PPD, SET, adaptive) and convert physical variables.
 
-Please cite us if you use this package: `Tartarini, F., Schiavon, S., 2020. pythermalcomfort: A Python package for thermal comfort research. SoftwareX 12, 100578. https://doi.org/10.1016/j.softx.2020.100578 <https://www.sciencedirect.com/science/article/pii/S2352711020302910>`_
+Please cite us if you use this package: `Tartarini, F., Schiavon, S., 2020. pythermalcomfort: A Python package for thermal comfort research. SoftwareX 12, 100578. https://doi.org/10.1016/j.softx.2020.100578 <https://scholar.google.com/citations?view_op=view_citation&hl=en&user=QcamSPwAAAAJ&citation_for_view=QcamSPwAAAAJ:hqOjcs7Dif8C>`_
 
 * Free software: MIT license
 

docs/conf.py

@@ -28,11 +28,11 @@
 extlinks = {
     "issue": (
         "https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/issues/%s",
-        "#",
+        "issue %s",
     ),
     "pr": (
         "https://github.com/CenterForTheBuiltEnvironment/pythermalcomfort/pull/%s",
-        "PR #",
+        "PR %s",
     ),
 }
 # on_rtd is whether we are on readthedocs.org

docs/reference/pythermalcomfort.rst

@@ -1,11 +1,6 @@
 Comfort models
 ==============
 
-.. testsetup::
-
-    from pythermalcomfort import *
-    from pythermalcomfort.models import *
-
 Adaptive ASHRAE
 ---------------
 
@@ -69,7 +64,7 @@ Humidex
 Joint system thermoregulation model (JOS-3)
 -------------------------------------------
 
-.. autoclass:: pythermalcomfort.models.JOS3.JOS3
+.. autoclass:: pythermalcomfort.models.jos3.JOS3
     :members:
     :undoc-members:
     :special-members: __init__
@@ -109,8 +104,8 @@ Standard Effective Temperature (SET)
 
 .. autofunction:: pythermalcomfort.models.set_tmp.set_tmp
 
-Two-node model (Gagge et al.)
------------------------------
+Two-node model
+--------------
 
 .. autofunction:: pythermalcomfort.models.two_nodes.two_nodes
 

src/pythermalcomfort/models/two_nodes.py

@@ -23,31 +23,18 @@ def two_nodes(
     max_skin_blood_flow=90,
     **kwargs,
 ):
-    """Two-node model of human temperature regulation Gagge et al. (1986).
-
-    [10]_ This model it can be used to calculate a variety of indices,
+    """Two-node model of human temperature regulation Gagge et al. (1986). [10]_
+    This model it can be used to calculate a variety of indices,
     including:
 
-    * Gagge's version of Fanger's Predicted Mean Vote (PMV). This function uses the Fanger's PMV equations but it replaces the heat loss and gain terms with those calculated by the two node model
-    developed by Gagge et al. (1986) [10]_.
-
-    * PMV SET and the predicted thermal sensation based on SET [10]_. This function is similar in all aspects to the :py:meth:`pythermalcomfort.models.pmv_gagge` however,
-    it uses the :py:meth:`pythermalcomfort.models.set` equation to calculate the dry heat loss by convection.
-
-    * Thermal discomfort (DISC) as the relative thermoregulatory strain necessary to restore a state of comfort and thermal equilibrium by sweating [10]_. DISC is described numerically as:
-    comfortable and pleasant (0), slightly uncomfortable but acceptable (1), uncomfortable and unpleasant (2), very uncomfortable (3), limited tolerance (4), and intolerable (S). The range of each
-    category is ± 0.5 numerically. In the cold, the classical negative category descriptions used for Fanger's PMV apply [10]_.
-
+    * Gagge's version of Fanger's Predicted Mean Vote (PMV). This function uses the Fanger's PMV equations but it replaces the heat loss and gain terms with those calculated by the two node model developed by Gagge et al. (1986) [10]_.
+    * PMV SET and the predicted thermal sensation based on SET [10]_. This function is similar in all aspects to the :py:meth:`pythermalcomfort.models.pmv_gagge` however, it uses the :py:meth:`pythermalcomfort.models.set` equation to calculate the dry heat loss by convection.
+    * Thermal discomfort (DISC) as the relative thermoregulatory strain necessary to restore a state of comfort and thermal equilibrium by sweating [10]_. DISC is described numerically as: comfortable and pleasant (0), slightly uncomfortable but acceptable (1), uncomfortable and unpleasant (2), very uncomfortable (3), limited tolerance (4), and intolerable (S). The range of each category is ± 0.5 numerically. In the cold, the classical negative category descriptions used for Fanger's PMV apply [10]_.
     * Heat gains and losses via convection, radiation and conduction.
-
     * The Standard Effective Temperature (SET)
-
     * The New Effective Temperature (ET)
-
     * The Predicted  Thermal  Sensation  (TSENS)
-
     * The Predicted  Percent  Dissatisfied  Due  to  Draft  (PD)
-
     * Predicted  Percent  Satisfied  With  the  Level  of  Air  Movement"   (PS)
 
     Parameters