First integration of JOS3 model and pythermalcomfort

[AkihisaNomoto]

Hello!

This is the first integration of JOS3 model and pythermalcomfort. The JOS-3 model code is basically copied from here (https://github.com/TanabeLab/JOS-3) but I newly added some description about the model and comments to the code for readers to easily understand.

Main changes are as follows;

• Added the main code of JOS3 model (class JOS3) into models.py. Please make sure the code works properly on your computer.
• The nomenclature is the same as the original code for now to keep consistency with the paper (https://www.sciencedirect.com/science/article/pii/S0378778820333612), but if you feel uncomfortable with that we can change it to keep consistency with the other nomenclature in pythermalcomfort.
• Probably you automatically sync the model's docstrings and pythermalcomfort documentaion but I am not sure JOS3 model's docstrings can be properly synced. Please comfirm this and modify as needed.
• Generate 'jos3' folder under 'pythermalcomfort' package. This folder has some python codes only for JOS3 model.
• Added an example code for JOS3 model called 'cals_jos3.py' in 'example' folder. Example outputs are in a folder named 'jos3_output_example'.
• Changed _body_surfacearea function in 'utilities.py'. Added some additional formula for calculating body surface area, not only dubois's formula.
• Added _add_prompt_tocode function in 'utilities.py' to make an example code in docstrings.

This is just an initial commit and I will modify the code for JOS3 model as needed.

Thanks, Aki

[codecov-commenter]

Codecov Report

Merging #44 (eb5a80c) into master (645fff6) will decrease coverage by 20.28%. The diff coverage is 17.18%.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@             Coverage Diff             @@
##           master      #44       +/-   ##
===========================================
- Coverage   67.68%   47.41%   -20.28%     
===========================================
  Files          10       14        +4     
  Lines        1597     2668     +1071     
  Branches      257      404      +147     
===========================================
+ Hits         1081     1265      +184     
- Misses        465     1348      +883     
- Partials       51       55        +4     

Impacted Files	Coverage Δ
src/pythermalcomfort/shared_functions.py	100.00% <ø> (ø)
...rc/pythermalcomfort/jos3_functions/construction.py	9.44% <9.44%> (ø)
...ythermalcomfort/jos3_functions/thermoregulation.py	11.39% <11.39%> (ø)
src/pythermalcomfort/utilities.py	69.81% <14.28%> (-2.56%)	:arrow_down:
src/pythermalcomfort/models.py	58.06% <20.39%> (-30.34%)	:arrow_down:
src/pythermalcomfort/jos3_functions/parameters.py	21.05% <21.05%> (ø)
src/pythermalcomfort/jos3_functions/matrix.py	22.56% <22.56%> (ø)

[AkihisaNomoto]

Hi,

Thanks for all your commnets.

Changes are as follows as we discussed yesterday;

• Chnaged the variables' names and make them consistent with the other functions in pythermalcomfort.
• Changed the code to allow the users to pass a dictionary as well as interger value, list, numpy array data format.

New chnages since yesterday is;

• Added csv file for local clothing insulations of typical cloting ensembles in pythermalcomfort folder for JOS-3 model input. This database is based on the study by Juyoun et al. (https://escholarship.org/uc/item/18f0r375) and by me (https://doi.org/10.1002/2475-8876.12124). I added a function to convert this csv file to dictionary and added the converted dictionary to utilities.py.

Pelase feel free to edit as you like.

Thank you again for adding me to pythermalcomfort co-maintainers. I am happy to internaly work on developing this model.

Akihisa

[AkihisaNomoto]

One more thing - I added a function to get the current version of pythermalcomfort from __init__.py and print it in the output of JOS-3 model to let the users know what version they are using. I think this is important because JOS-3 model can be further developed.

[AkihisaNomoto]

Sorry that I messed up a couple of lines of code. I think I could modify it and now all set.

[AkihisaNomoto]

Thanks for your comment. I modified the code based on your feedback.