Merge remote-tracking branch 'rob/enhancement/conda-environment' into…

… public
NREL · Oct 25, 2024 · 596b8c7 · 596b8c7
2 parents 5a73903 + 75a75bc
commit 596b8c7
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 318 deletions.
diff --git a/README.md b/README.md
@@ -48,13 +48,48 @@ King, J. and Hammond, S. "[Integrated Modeling, TEA, and Reference Design for Re
 
 ## Installing from Package Repositories
 
-1. GreenHEART is available as a PyPi package:
+```bash
+pip install greenheart
+```
+
+## Installing from Source
+
+### Easiest approach (recommended)
+
+1. Using Git, navigate to a local target directory and clone repository:
 
     ```bash
-    pip install greenheart
+    git clone https://github.com/NREL/GreenHEART.git
     ```
 
-## Installing from Source
+2. Navigate to `GreenHEART`
+
+    ```bash
+    cd GreenHEART
+    ```
+
+3. Create a conda environment and install GreenHEART and all its dependencies
+
+    ```bash
+    conda env create -f environment.yml
+    ```
+
+An additional step can be added if additional dependencies are required, or you plan to use this
+environment for development work.
+
+- Pass `-e` for an editable developer install
+- Use one of the extra flags as needed:
+  - `examples`: allows you to use the Jupyter Notebooks
+  - `develop`: adds developer and documentation tools
+  - `all` simplifies adding all the dependencies
+
+This looks like the following for a developer installation:
+
+```bash
+pip install -e ".[all]"
+```
+
+### Customizable
 
 1. Using Git, navigate to a local target directory and clone repository:
 
@@ -68,7 +103,8 @@ King, J. and Hammond, S. "[Integrated Modeling, TEA, and Reference Design for Re
     cd GreenHEART
     ```
 
-3. Create a new virtual environment and change to it. Using Conda and naming it 'greenheart':
+3. Create a new virtual environment and change to it. Using Conda Python 3.11 (choose your favorite
+   supported version) and naming it 'greenheart' (choose your desired name):
 
     ```bash
     conda create --name greenheart python=3.11 -y

diff --git a/environment.yml b/environment.yml
@@ -3,318 +3,10 @@ channels:
   - conda-forge
   - defaults
 dependencies:
-  - bzip2=1.0.8=h80987f9_6
-  - ca-certificates=2024.8.30=hf0a4a13_0
-  - coin-or-cbc=2.10.8=h1ce7d08_0
-  - coin-or-cgl=0.60.3=h950afdd_1
-  - coin-or-clp=1.17.6=h97646b0_2
-  - coin-or-osi=0.108.6=h3089036_1
-  - coin-or-utils=2.11.4=h8c5c8f5_2
-  - glpk=5.0=h6d7a090_0
-  - gmp=6.3.0=h7bae524_2
-  - libblas=3.9.0=25_osxarm64_openblas
-  - libcblas=3.9.0=25_osxarm64_openblas
-  - libcxx=19.1.2=ha82da77_0
-  - libffi=3.4.4=hca03da5_1
-  - libgfortran=5.0.0=13_2_0_hd922786_3
-  - libgfortran5=13.2.0=hf226fd6_3
-  - liblapack=3.9.0=25_osxarm64_openblas
-  - liblapacke=3.9.0=25_osxarm64_openblas
-  - libopenblas=0.3.28=openmp_h517c56d_0
-  - llvm-openmp=19.1.2=hb52a8e5_0
-  - ncurses=6.4=h313beb8_0
-  - openssl=3.3.2=h8359307_0
-  - pip=24.2=py311hca03da5_0
-  - python=3.11.10=hb885b13_0
-  - readline=8.2=h1a28f6b_0
-  - setuptools=75.1.0=py311hca03da5_0
-  - sqlite=3.45.3=h80987f9_0
-  - tk=8.6.14=h6ba3021_0
-  - wheel=0.44.0=py311hca03da5_0
-  - xz=5.4.6=h80987f9_1
-  - zlib=1.2.13=h18a0788_1
+  - python=3.11
+  - coin-or-cbc=2.10.8
+  - glpk
+  - pip
   - pip:
-      - about-time==4.2.1
-      - accumulation-tree==0.6.4
-      - aiounittest==1.4.2
-      - alabaster==0.7.16
-      - alembic==1.13.3
-      - alive-progress==3.1.5
-      - anyio==4.6.2.post1
-      - appdirs==1.4.4
-      - appnope==0.1.4
-      - appscript==1.3.0
-      - argon2-cffi==23.1.0
-      - argon2-cffi-bindings==21.2.0
-      - arrow==1.3.0
-      - asttokens==2.4.1
-      - async-lru==2.0.4
-      - attrs==24.2.0
-      - autograd==1.7.0
-      - babel==2.16.0
-      - backoff==2.2.1
-      - bayesian-optimization==1.4.0
-      - beautifulsoup4==4.12.3
-      - bleach==6.1.0
-      - bokeh==3.6.0
-      - certifi==2024.8.30
-      - cffi==1.17.1
-      - cfgv==3.4.0
-      - charset-normalizer==3.4.0
-      - click==8.1.7
-      - cma==3.2.2
-      - colorama==0.4.0
-      - coloredlogs==15.0.1
-      - colorlog==6.8.2
-      - comm==0.2.2
-      - contexttimer==0.3.3
-      - contourpy==1.3.0
-      - coolprop==6.6.0
-      - coverage==7.6.4
-      - cycler==0.12.1
-      - cython==3.0.11
-      - debugpy==1.8.7
-      - decorator==5.1.1
-      - deepdiff==8.0.1
-      - defusedxml==0.7.1
-      - deprecated==1.2.14
-      - dill==0.3.9
-      - directsearch==1.0
-      - diskcache==5.6.3
-      - distlib==0.3.9
-      - docopt==0.6.2
-      - docutils==0.18.1
-      - electrolyzer==0.1.0
-      - entrypoints==0.4
-      - et-xmlfile==2.0.0
-      - executing==2.1.0
-      - fastjsonschema==2.20.0
-      - fastkml==0.12
-      - filelock==3.16.1
-      - flexcache==0.3
-      - flexparser==0.3.1
-      - floris==4.1.1
-      - fonttools==4.54.1
-      - fqdn==1.5.1
-      - fsspec==2024.10.0
-      - funcy==2.0
-      - future==1.0.0
-      - getjson==2.0.0
-      - global-land-mask==1.0.0
-      - grapheme==0.6.0
-      - greenheart==0.1.1
-      - greenlet==3.1.1
-      - h11==0.14.0
-      - h3==4.1.1
-      - hopp==3.0
-      - httpcore==1.0.6
-      - httpx==0.27.2
-      - humanfriendly==10.0
-      - humpday==0.7.1
-      - hybridbosse==0.9.6
-      - identify==2.6.1
-      - idna==3.10
-      - imagesize==1.4.1
-      - importlib-metadata==8.5.0
-      - importlib-resources==6.4.5
-      - iniconfig==2.0.0
-      - ipykernel==6.29.5
-      - ipympl==0.9.4
-      - ipyparallel==8.8.0
-      - ipython==8.29.0
-      - ipython-genutils==0.2.0
-      - ipywidgets==8.1.5
-      - isoduration==20.11.0
-      - jax==0.4.35
-      - jaxlib==0.4.35
-      - jedi==0.19.1
-      - jinja2==3.1.4
-      - joblib==1.4.2
-      - json5==0.9.25
-      - jsonpointer==3.0.0
-      - jsonschema==4.23.0
-      - jsonschema-specifications==2024.10.1
-      - jupyter-book==0.14.0
-      - jupyter-cache==0.6.1
-      - jupyter-client==8.6.3
-      - jupyter-core==5.7.2
-      - jupyter-events==0.10.0
-      - jupyter-lsp==2.2.5
-      - jupyter-server==2.14.2
-      - jupyter-server-terminals==0.5.3
-      - jupyterlab==4.2.5
-      - jupyterlab-pygments==0.3.0
-      - jupyterlab-server==2.27.3
-      - jupyterlab-widgets==3.0.13
-      - kiwisolver==1.4.7
-      - landscapes==0.0.12
-      - latexcodec==3.0.0
-      - lcoe==0.3.2
-      - linkify-it-py==2.0.3
-      - lxml==5.3.0
-      - mako==1.3.6
-      - markdown-it-py==2.2.0
-      - markupsafe==3.0.2
-      - marmot-agents==0.2.5
-      - matplotlib==3.9.2
-      - matplotlib-inline==0.1.7
-      - mdit-py-plugins==0.3.5
-      - mdurl==0.1.2
-      - microconventions==1.0.0
-      - mistune==3.0.2
-      - ml-dtypes==0.5.0
-      - muid==0.5.3
-      - multiprocessing-on-dill==3.5.0a4
-      - myst-nb==0.17.2
-      - myst-parser==0.18.1
-      - nbclient==0.7.4
-      - nbconvert==7.16.4
-      - nbformat==5.10.4
-      - nest-asyncio==1.6.0
-      - networkx==3.4.2
-      - nevergrad==1.0.5
-      - nodeenv==1.9.1
-      - notebook==7.2.2
-      - notebook-shim==0.2.4
-      - nrel-pysam==4.2.0
-      - num2words==0.5.13
-      - numexpr==2.10.1
-      - numpy==1.26.4
-      - numpy-financial==1.0.0
-      - numpydoc==1.6.0
-      - openmdao==3.35.0
-      - openpyxl==3.1.5
-      - opt-einsum==3.4.0
-      - optuna==4.0.0
-      - orbit-nrel==1.1
-      - orderly-set==5.2.2
-      - overrides==7.7.0
-      - packaging==24.1
-      - pandas==2.2.3
-      - pandocfilters==1.5.1
-      - parameterized==0.9.0
-      - parso==0.8.4
-      - pathlib==1.0.1
-      - patsy==0.5.6
-      - pexpect==4.9.0
-      - pillow==11.0.0
-      - pint==0.24.3
-      - platformdirs==4.3.6
-      - playwright==1.48.0
-      - plotly==5.24.1
-      - pluggy==1.5.0
-      - ply==3.11
-      - poap==0.1.26
-      - pre-commit==4.0.1
-      - profast==1.0.3
-      - prometheus-client==0.21.0
-      - prompt-toolkit==3.0.48
-      - psutil==6.1.0
-      - ptyprocess==0.7.0
-      - pure-eval==0.2.3
-      - pvmismatch==4.1
-      - pyaml==24.9.0
-      - pyarrow==17.0.0
-      - pybtex==0.24.0
-      - pybtex-docutils==1.0.3
-      - pycodestyle==2.12.1
-      - pycparser==2.22
-      - pydata-sphinx-theme==0.12.0
-      - pydocstyle==6.3.0
-      - pydoe2==1.3.0
-      - pydoe3==1.0.4
-      - pyee==12.0.0
-      - pygeoif==0.7
-      - pygments==2.18.0
-      - pymoo==0.6.1.3
-      - pymorton==1.0.5
-      - pyomo==6.8.0
-      - pyparsing==3.2.0
-      - pyproj==3.7.0
-      - pysolar==0.11
-      - pysot==0.3.3
-      - pytest==8.3.3
-      - python-benedict==0.33.1
-      - python-dateutil==2.9.0.post0
-      - python-dotenv==1.0.1
-      - python-fsutil==0.14.1
-      - python-json-logger==2.0.7
-      - python-rapidjson==1.20
-      - python-slugify==8.0.4
-      - pytz==2024.2
-      - pyudorandom==1.0.0
-      - pyyaml==6.0.2
-      - pyyaml-include==2.1
-      - pyzmq==26.2.0
-      - rainflow==3.2.0
-      - referencing==0.35.1
-      - requests==2.32.3
-      - rfc3339-validator==0.1.4
-      - rfc3986-validator==0.1.1
-      - rpds-py==0.20.0
-      - ruamel-yaml==0.18.6
-      - ruamel-yaml-clib==0.2.12
-      - schema==0.7.7
-      - scikit-learn==1.5.2
-      - scikit-optimize==0.10.2
-      - scipy==1.14.1
-      - send2trash==1.8.3
-      - shapely==2.0.6
-      - simpy==4.1.1
-      - six==1.16.0
-      - sniffio==1.3.1
-      - snowballstemmer==2.2.0
-      - soupsieve==2.6
-      - sphinx==5.0.2
-      - sphinx-book-theme==0.4.0rc1
-      - sphinx-comments==0.0.3
-      - sphinx-copybutton==0.5.2
-      - sphinx-design==0.3.0
-      - sphinx-external-toc==0.3.1
-      - sphinx-jupyterbook-latex==0.5.2
-      - sphinx-multitoc-numbering==0.1.3
-      - sphinx-sitemap==2.6.0
-      - sphinx-thebe==0.2.1
-      - sphinx-togglebutton==0.3.2
-      - sphinxcontrib-applehelp==2.0.0
-      - sphinxcontrib-bibtex==2.5.0
-      - sphinxcontrib-devhelp==2.0.0
-      - sphinxcontrib-htmlhelp==2.1.0
-      - sphinxcontrib-jsmath==1.0.1
-      - sphinxcontrib-qthelp==2.0.0
-      - sphinxcontrib-serializinghtml==2.0.0
-      - sqlalchemy==2.0.36
-      - stack-data==0.6.3
-      - statsmodels==0.14.4
-      - tabulate==0.9.0
-      - tdigest==0.5.2.2
-      - tenacity==9.0.0
-      - terminado==0.18.1
-      - testflo==1.4.19
-      - text-unidecode==1.3
-      - threadpoolctl==3.5.0
-      - timezonefinder==6.5.4
-      - tinycss2==1.4.0
-      - tornado==6.4.1
-      - tqdm==4.66.5
-      - traitlets==5.14.3
-      - types-python-dateutil==2.9.0.20241003
-      - typing-extensions==4.12.2
-      - tzdata==2024.2
-      - uc-micro-py==1.0.3
-      - uri-template==1.3.0
-      - urllib3==2.2.3
-      - utm==0.7.0
-      - virtualenv==20.27.0
-      - wcwidth==0.2.13
-      - webcolors==24.8.0
-      - webencodings==0.5.1
-      - websocket-client==1.8.0
-      - websockets==13.1
-      - widgetsnbextension==4.0.13
-      - winning==1.0.3
-      - wrapt==1.16.0
-      - xlwings==0.33.3
-      - xyzservices==2024.9.0
-      - zipp==3.20.2
-prefix: /Users/kbrunik/anaconda3/envs/greenheart
+    - ProFAST@git+https://github.com/NREL/ProFAST.git
+    - "."