Installation

---

Simple Install

1. Use conda (anaconda or miniconda) to create a phygnn environment: conda create --name phygnn python=3.9

   1. Note that phygnn is tested with python >= 3.8 via pip install. Users have reported issues installing phygnn using conda install.

2. Activate your new conda env: conda activate phygnn

3. Install with pip or conda:

   1. pip install NREL-phygnn

   2. conda install -c nrel nrel-phygnn

Developer Install

1. Use conda (anaconda or miniconda) to create a phygnn environment: conda create --name phygnn python=3.9

2. Activate your new conda env: conda activate phygnn

3. Clone the phygnn repository: git clone git@github.com:NREL/phygnn.git

4. Navigate to the cloned repo and checkout your desired branch: git checkout main or git checkout <branch>

5. Navigate to the phygnn directory that contains setup.py and run: pip install -e . (developer install) or pip install . (static install).

6. Test your installation:

   1. Start ipython and test the following import: from phygnn import PhysicsGuidedNeuralNetwork

   2. Navigate to the tests/ directory and run the command: pytest