Download & Install PyOED#

Currently the best approach is to install locally from source.
While unavailable currently, we plan in the near future to enable full installation via pip (host PyOED on PyPI) and conda (publish on a conda channel).

Install PyOED from Source (Recommended)#

1. Download PyOED’s source code

Navigate to the location you want to download PyOED’s source code to, then run:

git clone https://gitlab.com/ahmedattia/pyoed

2. Install Conda (or Mamba)

Conda (or Miniconda) can be installed from Conda’s official website.
You may alternatively use the Mamba package manager. In that case, install Mamba and replace conda with mamba in the instructions below.

3. Create Environment & Install Dependencies

conda env create -f environment.yml
conda activate pyoed-dev

This creates a new conda environment named pyoed-dev and activates it.

Note

Windows users: PyOED is developed and tested on Linux and macOS. On Windows, use the Windows Subsystem for Linux (WSL) and follow the same steps above inside the WSL terminal.

4. Install PyOED

Navigate to the top-level directory of the package (where pyproject.toml is located) and run:

pip install --upgrade pip
pip install -e .

Because all runtime dependencies were already installed by conda in step 3, pip only registers the package in editable (development) mode without pulling additional packages.

Install from conda channels (using conda)#

Warning

Not yet available (coming soon).

Currently, only installation from source is supported.

Install from PyPI (using pip)#

Warning

Not yet available (coming soon).

Currently, only installation from source is supported.