Skip to content

Commit d89098a

Browse files
committed
version 1.0.13b
1 parent 8d2d368 commit d89098a

28 files changed

+67
-311
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
.ipynb_checkpoints/
22
.DS_Store
33
__pycache__/
4+
wptherml/__pycache__/
5+
wptherml/datalib/__pycache__/
6+
wptherml/numlib/__pycache__/
47
.Python
58
build/
69
develop-eggs/

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,17 @@ on Windows, Mac, or Linux platforms
1616
* `git clone https://github.com/FoleyLab/wptherml.git`
1717
* `cd wptherml`
1818
* `python setup.py install`
19+
20+
- To run unit tests from cloned repository:
21+
* `cd test`
22+
* `python -m pytest test.py`
23+
24+
- The test script for running unit tests can be downloaded [here](https://github.com/FoleyLab/wptherml/blob/master/example/test/test.py)
1925

2026
- To install with pip:
2127
* `pip install wptherml`
22-
28+
29+
2330
- Open a new .py file in your favorite text editor or IDE, e.g.
2431

2532
`vim example.py`
@@ -347,3 +354,23 @@ def find_spp(wavelength_index)
347354
def find_pa()
348355
```
349356
{: .language-python}
357+
358+
## Extending the multilayer class
359+
360+
The multilayer class should provide a convenient mechanism for extension of the package to include
361+
additional applications (which might require different manipulations of the Fresnel
362+
quantities stored as the attributes self.reflectivity_array, self.emissivity_array,
363+
self.transmissivity_array, or the thermal emission stored as the attribute
364+
self.thermal_emission_array), or to include different classes of structures
365+
(non-planar structures, for example, where the same attributes self.reflectivity_array, etc.,
366+
would be computed by a different method than the transfer matrix method). The typical
367+
workflow to extend the capabilities of the package could include
368+
369+
- Identifying any new properties that will be computed by the
370+
extension and adding appropriate attributes to the multilayer class
371+
- Adding one or more functions to the libraries (stpvlib, etc.)
372+
that manipulates the Fresnel and/or thermal emission quantites as
373+
required to compute the new desired property
374+
- Adding one or more multilayer methods to call the new library functions
375+
and store the resulting data in new or existing multilayer attributes as appropriate.
376+

docs/Cooling.png

-443 KB
Binary file not shown.

docs/Cooling2.png

-396 KB
Binary file not shown.

docs/Fig_PV.png

-33.6 KB
Binary file not shown.

docs/Fig_STPV.png

-48.2 KB
Binary file not shown.

docs/Flowchart.png

-26.7 KB
Binary file not shown.

docs/Flowchart.pptx

-306 KB
Binary file not shown.

docs/JORS_Bib.docx

-251 KB
Binary file not shown.
-381 KB
Binary file not shown.

0 commit comments

Comments
 (0)