feat: removed ex_output

Author: FedericoTartarini

examples/calc_jos3.py

@@ -70,7 +70,6 @@ def detailed_simulation():
         sex="male",
         bmr_equation="japanese",
         bsa_equation="fujimoto",
-        ex_output="all",
     )
 
     # Set environmental conditions such as air temperature, mean radiant temperature using the setter methods.

pythermalcomfort/jos3_functions/parameters.py

@@ -80,360 +80,301 @@ class Default:
 
 
 ALL_OUT_PARAMS = {
-    "age": {"ex_output": True, "meaning": "age", "suffix": None, "unit": "years"},
+    "age": {"meaning": "age", "suffix": None, "unit": "years"},
     "bf_ava_foot": {
-        "ex_output": True,
         "meaning": "AVA blood flow rate of one foot",
         "suffix": None,
         "unit": "L/h",
     },
     "bf_ava_hand": {
-        "ex_output": True,
         "meaning": "AVA blood flow rate of one hand",
         "suffix": None,
         "unit": "L/h",
     },
     "bf_core": {
-        "ex_output": True,
         "meaning": "core blood flow rate (each body part)",
         "suffix": "Body name",
         "unit": "L/h",
     },
     "bf_fat": {
-        "ex_output": True,
         "meaning": "fat blood flow rate (each body part)",
         "suffix": "Body name",
         "unit": "L/h",
     },
     "bf_muscle": {
-        "ex_output": True,
         "meaning": "muscle blood flow rate (each body part)",
         "suffix": "Body name",
         "unit": "L/h",
     },
     "bf_skin": {
-        "ex_output": True,
         "meaning": "skin blood flow rate (each body part)",
         "suffix": "Body name",
         "unit": "L/h",
     },
     "bsa": {
-        "ex_output": True,
         "meaning": "body surface area (each body part)",
         "suffix": "Body name",
         "unit": "m2",
     },
     "cardiac_output": {
-        "ex_output": False,
         "meaning": "cardiac output (the sum of the whole blood flow)",
         "suffix": None,
         "unit": "L/h",
     },
     "e_max": {
-        "ex_output": True,
         "meaning": "maximum evaporative heat loss from the skin (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "e_skin": {
-        "ex_output": True,
         "meaning": "evaporative heat loss from the skin (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "e_sweat": {
-        "ex_output": True,
         "meaning": (
             "evaporative heat loss from the skin by only sweating (each body part)"
         ),
         "suffix": "Body name",
         "unit": "W",
     },
-    "fat": {"ex_output": True, "meaning": "body fat rate", "suffix": None, "unit": "%"},
+    "fat": {"meaning": "body fat rate", "suffix": None, "unit": "%"},
     "height": {
-        "ex_output": True,
         "meaning": "body height",
         "suffix": None,
         "unit": "m",
     },
     "clo": {
-        "ex_output": True,
         "meaning": "clothing insulation (each body part)",
         "suffix": "Body name",
         "unit": "clo",
     },
     "q_skin2env_latent": {
-        "ex_output": True,
         "meaning": "latent heat loss from the skin (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_bmr_core": {
-        "ex_output": True,
         "meaning": "core thermogenesis by basal metabolism (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_bmr_fat": {
-        "ex_output": True,
         "meaning": "fat thermogenesis by basal metabolism (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_bmr_muscle": {
-        "ex_output": True,
         "meaning": "muscle thermogenesis by basal metabolism (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_bmr_skin": {
-        "ex_output": True,
         "meaning": "skin thermogenesis by basal metabolism (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_thermogenesis_total": {
-        "ex_output": False,
         "meaning": "total thermogenesis of the whole body",
         "suffix": None,
         "unit": "W",
     },
     "q_nst": {
-        "ex_output": True,
         "meaning": "core thermogenesis by non-shivering (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "simulation_time": {
-        "ex_output": False,
         "meaning": "simulation times",
         "suffix": None,
         "unit": "sec",
     },
     "q_shiv": {
-        "ex_output": True,
         "meaning": "core or muscle thermogenesis by shivering (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_work": {
-        "ex_output": True,
         "meaning": "core or muscle thermogenesis by work (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "name": {
-        "ex_output": True,
         "meaning": "name of the model",
         "suffix": None,
         "unit": "-",
     },
     "par": {
-        "ex_output": True,
         "meaning": "physical activity ratio",
         "suffix": None,
         "unit": "-",
     },
     "q_thermogenesis_core": {
-        "ex_output": True,
         "meaning": "core total thermogenesis (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_thermogenesis_fat": {
-        "ex_output": True,
         "meaning": "fat total thermogenesis (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_thermogenesis_muscle": {
-        "ex_output": True,
         "meaning": "muscle total thermogenesis (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_thermogenesis_skin": {
-        "ex_output": True,
         "meaning": "skin total thermogenesis (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_res": {
-        "ex_output": False,
         "meaning": "heat loss by respiration",
         "suffix": None,
         "unit": "W",
     },
     "q_res_latent": {
-        "ex_output": True,
         "meaning": "latent heat loss by respiration (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "q_res_sensible": {
-        "ex_output": True,
         "meaning": "sensible heat loss by respiration (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "rh": {
-        "ex_output": True,
         "meaning": "relative humidity (each body part)",
         "suffix": "Body name",
         "unit": "%",
     },
     "r_et": {
-        "ex_output": True,
         "meaning": "total clothing evaporative heat resistance (each body part)",
         "suffix": "Body name",
         "unit": "(m2*kPa)/W",
     },
     "r_t": {
-        "ex_output": True,
         "meaning": "total clothing heat resistance (each body part)",
         "suffix": "Body name",
         "unit": "(m2*K)/W",
     },
     "q_skin2env_sensible": {
-        "ex_output": True,
         "meaning": "sensible heat loss from the skin (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "t_skin_set": {
-        "ex_output": True,
         "meaning": "skin set point temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_core_set": {
-        "ex_output": True,
         "meaning": "core set point temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "sex": {
-        "ex_output": True,
         "meaning": "sex",
         "suffix": None,
         "unit": "-",
     },
     "q_skin2env": {
-        "ex_output": False,
         "meaning": "total heat loss from the skin (each body part)",
         "suffix": "Body name",
         "unit": "W",
     },
     "tdb": {
-        "ex_output": True,
         "meaning": "dry bulb air temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_artery": {
-        "ex_output": True,
         "meaning": "arterial temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_cb": {
-        "ex_output": True,
         "meaning": "central blood temperature",
         "suffix": None,
         "unit": "°C",
     },
     "t_core": {
-        "ex_output": False,
         "meaning": "core temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_fat": {
-        "ex_output": True,
         "meaning": "fat temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_muscle": {
-        "ex_output": True,
         "meaning": "muscle temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "to": {
-        "ex_output": True,
         "meaning": "operative temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "tr": {
-        "ex_output": True,
         "meaning": "mean radiant temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_skin": {
-        "ex_output": False,
         "meaning": "skin temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_skin_mean": {
-        "ex_output": False,
         "meaning": "mean skin temperature",
         "suffix": None,
         "unit": "°C",
     },
     "t_superficial_vein": {
-        "ex_output": True,
         "meaning": "superficial vein temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "t_vein": {
-        "ex_output": True,
         "meaning": "vein temperature (each body part)",
         "suffix": "Body name",
         "unit": "°C",
     },
     "v": {
-        "ex_output": True,
         "meaning": "air velocity (each body part)",
         "suffix": "Body name",
         "unit": "m/s",
     },
     "weight": {
-        "ex_output": True,
         "meaning": "body weight",
         "suffix": None,
         "unit": "kg",
     },
     "w": {
-        "ex_output": False,
         "meaning": "skin wettedness (each body part)",
         "suffix": "Body name",
         "unit": "-",
     },
     "w_mean": {
-        "ex_output": False,
         "meaning": "mean skin wettedness",
         "suffix": None,
         "unit": "-",
     },
     "weight_loss_by_evap_and_res": {
-        "ex_output": False,
         "meaning": "weight loss by the evaporation and respiration of the whole body",
         "suffix": None,
         "unit": "g/sec",
     },
     "dt": {
-        "ex_output": False,
         "meaning": "time step",
         "suffix": None,
         "unit": "sec",
     },
     "pythermalcomfort_version": {
-        "ex_output": False,
         "meaning": "version of pythermalcomfort",
         "suffix": None,
         "unit": "-",
@@ -470,10 +411,7 @@ def show_out_param_docs():
 
         line = "{}: {} [{}]".format(key.ljust(8), value["meaning"], value["unit"])
 
-        if value["ex_output"]:
-            exoutparams += line + "\n"
-        else:
-            outparams += line + "\n"
+        outparams += line + "\n"
 
     docs = outparams + "\n" + exoutparams
     docs = textwrap.indent(docs.strip(), "    ")

pythermalcomfort/models/atcs.py

@@ -49,12 +49,6 @@ def __init__(self, *args, **kwargs):
             Choose one from pythermalcomfort.utilities.BodySurfaceAreaEquations. Default is "dubois".
             The body surface area can be calculated using the function
             :py:meth:`pythermalcomfort.utilities.body_surface_area`.
-        ex_output : None, list or "all", optional
-            This is used when you want to display results other than the default output parameters (ex.skin temperature);
-            by default, JOS outputs only the most necessary parameters in order to reduce the computational load.
-            If the parameters other than the default output parameters are needed,
-            specify the list of the desired parameter names in string format like ["bf_skin", "bf_core", "t_artery"].
-            If you want to display all output results, set ex_output is "all".
 
         Attributes
         ----------