Installation

Install opgee in an Anaconda virtual environment

  1. Download and install Anaconda for your platform. Note that opgee requires Python 3.8 or later.

The most convenient way to install and manage a scientific Python environment is to use 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 may have to install more packages. Note that all development and testing of opgee uses Anaconda. Follow the installation instructions for your platform.

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

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

  1. Activate the new environment:

conda activate opgee

  1. [THIS STEP DOESN’T WORK YET.] Finally, install the opgee package into the newly created environment:

    # pip install opgee

Until a release is available on the PyPI.org server, use these steps instead:

git clone https://github.com/Stanford-EAO/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.

Working with opgee source code

If you are interested in working with the source code (e.g., writing plugins or adding functionality), you should clone the code repository (https://github.com/Stanford-EAO/OPGEEv4) to create a local copy. You can then install opgee in “developer” mode using the setup.py script found in the top-level OPGEEv4 directory. This creates links from the installed package to the source code repository so changes to the source code are available immediately without requiring re-installation of opgee.

# Uninstall opgee if you installed it previously: this avoids
# potential conflicts with previously installed files.
pip uninstall opgee

# Change directory to where you want the opgee folder to be "cloned"
cd (wherever you want)

# Clone the git repository
git clone https://github.com/Stanford-EAO/OPGEEv4
cd OPGEEv4

# Install opgee in developer mode
python setup.py develop

The setup.py script uses a Python module called setuptools. On Mac OS X and Linux, setup.py installs setuptools automatically. Unfortunately, this has been less reliable on Windows, so if the commands above fail, you will have to install setuptools. To install setuptools manually, run this command in a terminal:

conda install setuptools