version 1.0.13b

FoleyLab · Jul 10, 2019 · d89098a · d89098a
1 parent 8d2d368
commit d89098a
Show file tree

Hide file tree

Showing 28 changed files with 67 additions and 311 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,9 @@
 .ipynb_checkpoints/
 .DS_Store
 __pycache__/
+wptherml/__pycache__/
+wptherml/datalib/__pycache__/
+wptherml/numlib/__pycache__/
 .Python
 build/
 develop-eggs/

diff --git a/README.md b/README.md
@@ -16,10 +16,17 @@ on Windows, Mac, or Linux platforms
    * `git clone https://github.com/FoleyLab/wptherml.git`
    * `cd wptherml`
    * `python setup.py install`
+
+- To run unit tests from cloned repository:
+   * `cd test`
+   * `python -m pytest test.py`
+
+- The test script for running unit tests can be downloaded [here](https://github.com/FoleyLab/wptherml/blob/master/example/test/test.py)
 
 - To install with pip:
    * `pip install wptherml`
-
+
+
 - Open a new .py file in your favorite text editor or IDE, e.g.
 
 `vim example.py`
@@ -347,3 +354,23 @@ def find_spp(wavelength_index)
 def find_pa()
 ```
 {: .language-python}
+
+## Extending the multilayer class
+
+The multilayer class should provide a convenient mechanism for extension of the package to include 
+additional applications (which might require different manipulations of the Fresnel 
+quantities stored as the attributes self.reflectivity_array, self.emissivity_array, 
+self.transmissivity_array, or the thermal emission stored as the attribute 
+self.thermal_emission_array), or to include different classes of structures 
+(non-planar structures, for example, where the same attributes self.reflectivity_array, etc., 
+would be computed by a different method than the transfer matrix method).  The typical 
+workflow to extend the capabilities of the package could include
+
+- Identifying any new properties that will be computed by the 
+extension and adding appropriate attributes to the multilayer class
+- Adding one or more functions to the libraries (stpvlib, etc.) 
+that manipulates the Fresnel and/or thermal emission quantites as 
+required to compute the new desired property
+- Adding one or more multilayer methods to call the new library functions 
+and store the resulting data in new or existing multilayer attributes as appropriate.
+
diff --git a/docs/Cooling.png b/docs/Cooling.png
diff --git a/docs/Cooling2.png b/docs/Cooling2.png
diff --git a/docs/Fig_PV.png b/docs/Fig_PV.png
diff --git a/docs/Fig_STPV.png b/docs/Fig_STPV.png
diff --git a/docs/Flowchart.png b/docs/Flowchart.png
diff --git a/docs/Flowchart.pptx b/docs/Flowchart.pptx
diff --git a/docs/JORS_Bib.docx b/docs/JORS_Bib.docx
diff --git a/docs/Screen Shot 2019-02-26 at 10.26.09 AM.png b/docs/Screen Shot 2019-02-26 at 10.26.09 AM.png
diff --git a/docs/Spectral Response.png b/docs/Spectral Response.png
diff --git a/docs/cooling_fig.png b/docs/cooling_fig.png
diff --git a/docs/cooling_fig_IR.png b/docs/cooling_fig_IR.png
diff --git a/docs/graph.png b/docs/graph.png
diff --git a/docs/graph_2.png b/docs/graph_2.png
diff --git a/docs/graph_3.png b/docs/graph_3.png
diff --git a/docs/graph_4.png b/docs/graph_4.png
diff --git a/docs/jors 2-18-19_JJF_v1.docx b/docs/jors 2-18-19_JJF_v1.docx
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.0.11b'
+version = '1.0.13'
 # The full version, including alpha/beta/rc tags.
-release = '1.0.11b'
+release = '1.0.13b'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/readme.rst b/docs/source/readme.rst
@@ -32,6 +32,13 @@ Quick Start
 -  ``cd wptherml``
 -  ``python setup.py install``
 
+-  To run unit tests from cloned repository:
+-  ``cd test``
+-  ``python -m pytest test.py``
+
+-  The test script for running unit tests can be downloaded
+   `here <https://github.com/FoleyLab/wptherml/blob/master/example/test/test.py>`__
+
 -  To install with pip:
 -  ``pip install wptherml``
 
@@ -403,3 +410,26 @@ emission of structure defined as Blackbody \* emissivity \`\`\` {:
     def find_pa()
 
 {: .language-python}
+
+Extending the multilayer class
+------------------------------
+
+The multilayer class should provide a convenient mechanism for extension
+of the package to include additional applications (which might require
+different manipulations of the Fresnel quantities stored as the
+attributes self.reflectivity\_array, self.emissivity\_array,
+self.transmissivity\_array, or the thermal emission stored as the
+attribute self.thermal\_emission\_array), or to include different
+classes of structures (non-planar structures, for example, where the
+same attributes self.reflectivity\_array, etc., would be computed by a
+different method than the transfer matrix method). The typical workflow
+to extend the capabilities of the package could include
+
+-  Identifying any new properties that will be computed by the extension
+   and adding appropriate attributes to the multilayer class
+-  Adding one or more functions to the libraries (stpvlib, etc.) that
+   manipulates the Fresnel and/or thermal emission quantites as required
+   to compute the new desired property
+-  Adding one or more multilayer methods to call the new library
+   functions and store the resulting data in new or existing multilayer
+   attributes as appropriate.
diff --git a/docs/stpv_fig.png b/docs/stpv_fig.png
diff --git a/docs/~$rs 2-18-19_JJF_v1.docx b/docs/~$rs 2-18-19_JJF_v1.docx
diff --git a/example/Validate_Cooling.ipynb b/example/Validate_Cooling.ipynb
@@ -171,7 +171,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The two results agree to 2 significant figures, which is reasonable considering the errors mentioned above, is reasonable to validate that our angular and wavelength integration performed within the cooling_power() method is functioning.  \n",
+    "The two results agree to 2 significant figures, which is reasonable considering the errors mentioned above, is reasonable to validate that our angular and wavelength integration performed within the cooling_power() method is functioning.  The accuracy could be systematically improved by (1) increasing the wavelength range of integration by decreasing (increasing) the minimum (maximum) wavelengths in Lambda_List, (2) increasing the wavelength resolution by increasing the number of wavelengths in Lambda_List, and (3) increasing the angular resolution by increasing the number of angles in the angular integrals using 'DEG' keyword in the structure dictionary.  For example, the entry \n",
+    "'DEG': 10 would perform the angular integrals over 10 different angles rather than the default 7.  Increasing the wavelength and angular resolution will increase the computation time.\n",
     "\n",
     "We can also re-plot the quantities as before to visualize how the step_emissivity() method modifies the emissivity of cool_ml."
    ]
@@ -250,7 +251,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.4"
+   "version": "3.6.8"
   }
  },
  "nbformat": 4,

diff --git a/example/Validate_Fresnel_ML1.py b/example/Validate_Fresnel_ML1.py
diff --git a/example/Validate_Fresnel_ML2.py b/example/Validate_Fresnel_ML2.py
diff --git a/example/Validate_Fresnel_ML3.py b/example/Validate_Fresnel_ML3.py