Skip to content

Install and run PyPOLAR with PyPI

Cristel Chandre edited this page Oct 28, 2024 · 14 revisions

Requirements for installing packages

  • Ensure you can run Python from the command line

Open a Terminal window (or a PowerShell on Windows) and run the following command:

python3 --version

If Python is not installed on your computer or if the version is lower than 3.8, please install or upgrade to a new version of Python. For a complete guide on how to do it, click here

  • Ensure you can run pip from the command line
python3 -m pip --version

For more information about these requirements, click here

Create a Python virtual environment

Run the following command once and for all on the computer where you want you to install PyPOLAR:

python3 -m venv pypolar_env

Once pypolar_env created, it serves as the virtual environment where PyPOLAR will be able to run. If you want to know more about Python virtual environments, click here.

Installing PyPOLAR from PyPI

Run the following command for each installation and upgrade of PyPOLAR:

source pypolar_env/bin/activate
python3 -m pip install polarimetry

For installing a specific version:

source pypolar_env/bin/activate
python3 -m pip install polarimetry==XXX

where XXX is the version number, e.g., 2.6.4

Run PyPOLAR

Run the following command each time you want to use PyPOLAR

source pypolar_env/bin/activate
pypolar