Installation

Note that OPGEEv4 is not currently installable as a Python package from the “pip” package server. Please follow the instructions below.

Install opgee in an Anaconda virtual environment

  1. Download and install Anaconda for your platform. Note that the current version of opgee has been tested on Python 3.11.

OPGEE has been developed and tested using the free Anaconda distribution. Anaconda includes most of the scientific and statistical modules used by opgee. You can, however, use any installation of Python if you prefer. Without Anaconda you will not be able to use the YML file below and may have to install more packages.

  1. Download the YML file from the OPGEEv4 github repository:

    This file has been verified to work correctly on MS Windows, macOS, and Linux.

  2. Run the following command, replacing the /path/to/py3-opgee.yml with the path to the file you downloaded in step 1:

# Replace "/path/to/py3-opgee.yml" with path to the file you downloaded
conda env create -f /path/to/py3-opgee.yml

  1. Activate the new environment:

conda activate opgee

  1. Clone the OPGEE repository and install the OPGEE package into the activated environment:

git clone https://github.com/msmasnadi/OPGEEv4.git
cd OPGEEv4
pip install -e .

which links the installed package back to the source code repo.

See also

See the conda documentation for further details on managing environments.