Installation

The easiest way to install alexandria3k and its dependencies is through PyPI.

python3 -m pip install --use-pep517 alexandria3k

or

pip install --use-pep517 alexandria3k

The installation requires at least Python version 3.7 and is tested with Python versions 3.7 to 3.11. The best practice is to perform the installation in a Python virtual environment.

Local documentation

The documentation of alexandria3k is available online If you want a local copy, you can create the HTML files by cloning the alexandria3k repository, installing the required development dependencies, and running make html in the docs directory. The HTML files will be made available in the docs/_build directory.

Similarly, if you want to install a Unix manual page for the a3k command-line interface, you can run make manpage (kudos to you BTW). You can then install the man page made available at docs/_build/a3k.1 in your preferred man page source file location, e.g. /usr/local/share/man/man1 or $HOME/man/man1.