This code is intended for a GNU/Linux environment. It has not been tested outside GNU/Linux. A version of Python version >= 3.6 is required.

It is recommended for installers to create a Python virtual environment for testing the code, for instance (you may need first to use your Linux package manager to install python3-venv):

$ python3 -m venv ~/virtual_env
$ source ~/virtual_env/bin/activate

If your pip version is out of date, it needs to be upgraded (version>=20.0):

(virtual_env) $ pip3 --version
(virtual_env) $ pip3 install -U pip
(virtual_env) $ pip3 --version

Pyclamp is installed using a pip installer from the working directory path of this README.md file:

(virtual_env) $ file README.md
README.md: ASCII text
(virtual_env) $ pip3 install -e .

If this fails, check your Python version is up to date.

(virtual_env) $ ./run_pyclamp

After finishing with the package, the dependencies can be removed:

(virtual_env) $ deactivate
$ rm -r ~/virtual_env/