Merge pull request #127 from NREL/release-1.2

Release 1.2

Author: rjhanes

ReadMe.md

@@ -1,15 +1,30 @@
 *Tyche:* *T*echnolog*y* *Ch*aracterization and *E*valuation
 ===========================================================
 
-*   documentation:
-    *   [web](https://tyche.live/)
-    *   [PDF](https://github.com/NREL/tyche-docs/blob/dev/Tyche.pdf)
-    *   [Markdown](index.rst)
-*   Conda environments: [conda/](conda/)
-*   Python packages:
-    *   evaluation and optimization: [src/tyche/](src/tyche/)
-    *   web-based user interface: [src/eutychia/](src/eutychia/)
-    *   technology models: [src/technology/](src/technology/)
-*   Interim operational capabilities:
-    *   [IOC-0](ioc-0/ReadMe.md): Proof-of-principle examples.
-    *   [IOC-1](ioc-1/ReadMe.md): PV components, technologies, and materials/waste for Mock FOA.
+See our complete documentation on [GitHub Pages](https://nrel.github.io/tyche-docs/) or in downloadable PDF format [here](https://github.com/NREL/tyche-docs/blob/main/Tyche.pdf).
+
+If you would like to download the Tyche software, please visit our [releases page](https://github.com/NREL/tyche/releases) to access the most recent release.
+
+The directory structure of this repository is as follows:
+
+* conda: Conda environment specification files for use when installing or updating Tyche.
+* docs: Documentation source files and related metadata.
+* src: Tyche's code base
+	* eutychia: Code for the browser-based graphical user interface
+	* technology: Datasets, models, and analysis Jupyter notebooks for Tyche case studies. Subdirectories contain the datasets and notebooks for each case study.
+		* pv-residential-large
+		* pv-residential-simple
+		* simple-electrolysis
+		* transport-model
+		* tutorial-basic
+		* tutorial-biorefinery
+		* utility-pv
+	* tyche: Code for ensemble evaluation and stochastic optimization.
+	
+The branch structure of this repository is as follows:
+
+* `main` contains the current stable and released version of Tyche and can only be altered via approved pull request
+* `dev` contains the latest working version of Tyche and may contain unresolved bugs. Commits directly to `dev` should be avoided except for urgent bug fixes and last minute pre-release commits.
+* All other branches are feature branches under active development and should not be used for applications.
+
+

conda/mac.yml

@@ -0,0 +1,19 @@
+name: tyche
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - hypercorn=0.14.3
+  - matplotlib=3.6.2
+  - myst-parser=0.18.1
+  - notebook=6.4.12
+  - openpyxl=3.0.10
+  - pip=22.2.2
+  - python=3.10.4
+  - quart=0.18.1
+  - scipy=1.9.1
+  - seaborn=0.12.1
+  - sphinx=5.0.2
+  - tk=8.6.12
+  - pip:
+    - mip==1.14.1