@@ -27,7 +27,14 @@ Quick Start
2727 matplotlib packages. Current installation of the Anaconda Python 3
2828 package should provide all you need on Windows, Mac, or Linux
2929 platforms
30- - To get started, clone or download this repository to your computer
30+ - To install from github:
31+ - ``git clone https://github.com/FoleyLab/wptherml.git ``
32+ - ``cd wptherml ``
33+ - ``python setup.py install ``
34+
35+ - To install with pip:
36+ - ``pip install wptherml ``
37+
3138- Open a new .py file in your favorite text editor or IDE, e.g.
3239
3340``vim example.py ``
@@ -70,10 +77,10 @@ TiO2 and 100 nm SiO2, and plots it using pyplot follows:
7077
7178- Save this script and run it either in the terminal as
7279
73- ``python test .py ``
80+ ``python example .py ``
7481
75- where test .py is the name of the file you created, or if you were doing
76- this in an IDE, execute it within your IDE!
82+ where example .py is the name of the file you created, or if you were
83+ doing this in an IDE, execute it within your IDE!
7784
7885The schematic that illustrates the above example is shown in the figure
7986below. Note the ordering of the layers in the picture and how they are
@@ -84,20 +91,20 @@ There are illustrative examples of using the features of the multilayer
8491class contained in Jupyter notebooks within this repository, including:
8592
8693- `Validation of Basic Optical
87- Properties <https://github.com/FoleyLab/wptherml/blob/master/Validate_Fresnel.ipynb> `__
94+ Properties <https://github.com/FoleyLab/wptherml/blob/master/example/ Validate_Fresnel.ipynb> `__
8895
8996- `Examples of Computing Basic Optical
90- Properties <https://github.com/FoleyLab/wptherml/blob/master/Example1.ipynb> `__
97+ Properties <https://github.com/FoleyLab/wptherml/blob/master/example/ Example1.ipynb> `__
9198
9299- `Modeling Incandescent
93- Sources <https://github.com/FoleyLab/wptherml/blob/master/Example2.ipynb> `__
100+ Sources <https://github.com/FoleyLab/wptherml/blob/master/example/ Example2.ipynb> `__
94101
95102- `Modeling Radiative Cooling
96- Surfaces <https://github.com/FoleyLab/wptherml/blob/master/Validate_Cooling.ipynb> `__
103+ Surfaces <https://github.com/FoleyLab/wptherml/blob/master/example/ Validate_Cooling.ipynb> `__
97104
98105- `Video Demo for Radiative Cooling <https://youtu.be/LC4TrnB8JK4 >`__
99106
100- more will be added in the near future!
107+ More will be added in the near future!
101108
102109Playlist
103110--------
0 commit comments