Installing pyOpTools

Getting it

pyOpTools can be downloaded from the project GitHub repository at:

Installing it in Debian 10 (should work on any Debian derivative)

pyOpTools is being developed almost exclusively using “Debian derivative” Linux distributions, so this installation procedure is the most tested and reliable. To generate the pyoptool .deb package you just need to run the following command in the project root:

make deb

This will create a .deb package outside the pyOpTool’s source root tree. This can be installed using the command:

dpkg -i python3-pyoptools_<version>_<platform>.deb

where version/platform should be adjusted accordingly.

Installing pyOpTools inside a python virtualenv

After a Python3 virtualenv is creates and activated, pyOpTools can be installed by running the following command, inside the project root:

pip install -r requirements.txt
python3 setup.py install

Visualizing pyOpTools simulations in a Jupyter notebook

To use pyOpTools together with jupyter, the jupyter plugin pythreejs must be installed. To install it in the user directory, use the following instructions:

pip3 install pythreejs --user
jupyter nbextension install --user --py pythreejs
jupyter nbextension enable pythreejs --user --py

after this is done, you will be able to visualize the simulations using the Plot3D() command.

The plot window is interactive. Using the mouse, it is possible to rotate the image by click and drag with the left button, zoom by using the scroll wheel and translate by click and drag with the right button.