Installation¶
The simplest way to install the most recent release of Jonga from PyPI is
pip install jonga
Jonga can also be installed from source, either from the development version from GitHub, or from a release source package downloaded from PyPI.
To install the development version from GitHub do
git clone git://github.com/bwohlberg/jonga.git
followed by
cd jonga
python setup.py build
python setup.py install
The install command will usually have to be performed with root permissions, e.g. on Ubuntu Linux
sudo -H python setup.py install
The procedure for installing from a source package downloaded from PyPI is similar.
Note that under Ubuntu Linux, in the commands listed above, python
and pip
should be replaced with python3
and pip3
respectively.
Jonga can also be installed as a conda package from the conda-forge channel
conda install -c conda-forge jonga
Requirements¶
The primary requirement is Python 3.3 or greater (this packages is
not compatible with Python 2), imposed by the use of the
__qualname__
function attribute and inspect.getclosurevars.
The __qualname__
attribute could be replaced in earlier versions
of Python by qualname, but
there is no obvious replacement for inspect.getclosurevars,
which was introduced in Python 3.3.
The other major requirement is pygraphviz. Under Ubuntu Linux 18.04, this requirement can be installed by the command
sudo apt-get install python3-pygraphviz
Optional¶
Package matplotlib is required to run the included Jupyter Notebook examples.
Packages pytest and
pytest-runner are
required to run the tests (python setup.py test
or python3
setup.py test
, depending on the operating system).
Packages sphinx,
sphinx-bootstrap-theme,
and numpydoc are required to
build the documentation (python setup.py build_sphinx
or
python3 setup.py build_sphinx
, depending on the operating system).