Currently, we are not looking for any new contributors.
Below is a list of useful information for developers.
Install qgym in editable mode (preferably virtual) environment as follows:
pip install --upgrade pip
pip install -e .[dev]
This will install the qgym package together with all tools needed for developing.
To build a wheel from this source one can run the command below.
This will create a built wheel in a folder called dist.
pip install --upgrade build
python -m build
To build the documentation one should run the command below.
python docs_files/make_docs.py
The HTML documentation will be placed in a folder called docs. This folder includes a
file index.html, open this in a browser to view the documentation.
To successfully build the documentation, one has to have the qgym packages installed.
To launch a jupyter notebook environment ensure that the latest version of this library is installed. If you are sure everything is up to date you can run:
pip install -U .[dev]
jupyter notebook