Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 1.57 KB

README.md

File metadata and controls

78 lines (50 loc) · 1.57 KB

Optical Networking Gym

An Open-Source Toolkit for Benchmarking Resource Assignment Problems in Optical Networks

Installation

We recommend installing an environment using Python's venv module:

python -m venv .venv

Then activating it:

source .venv/bin/activate

Then, install the project:

pip install -e .

Alternatively, you can install with the development and research dependencies:

pip install -e ".[dev,research]"

Development

To install the development dependencies, after the installation steps above, run:

pip install -e ".[dev]"

To build and run tests:

DEBUG=1 python setup.py clean --all build_ext --force --inplace && coverage run -m pytest && coverage report

We recommend the use of VSCode with the extension ktnrg45.vscode-cython to enable code completion and highlighting in .pyx (Cython) files.

Research

To install the research dependencies, after the installation steps above, run:

pip install -e ".[research]"

Contributing

Contributions from the community are welcome. To start the process, open an issue in GitHub. Then, we can discuss the functionality, and if the feature you are interested in is of the interest of the maintainers. After that, we can accept pull requests.

Maintainers