3. Installing phenopype

3.1. Initial installation

Activate your virtual environment:

conda activate <NAME>                           # <NAME> == chosen name, e.g. "pp-env"

Install phenopype to your environment using pip (pip is the main package manager for Python):

pip install phenopype

That’s it - happy phenopyping! You can now use phenopype by after loading python or spyder from the terminal. You can also use phenopype from a jupyter notebook - for more details, give the tutorials a try.

Warning

Always remember to activate your environment before trying to run Spyder or phenopype.

3.2. Installing updates

For regular major and minor releases, use the -U flag with pip:

pip install phenopype -U

3.3. Installing from dev branch

You can install phenopype directly from the latest commit developmental branch to test experimental features and new implementations.

Warning

This is generally not recommended and should only be done if you know what you’re doing, or if you have been contacted by the phenopype developers.

pip install https://github.com/phenopype/phenopype/archive/dev.zip

3.4. Installing past versions

Major releases are not backwards compatible, so if you have existing phenopype projects that were created with a previous version you need to download that specific version. You can tell pip to do so, for example, for version 1.0.0:

pip install "phenopype==1.0.0"

Or, for the latest phenopype version that is still 1.x.x:

pip install "phenopype < 2"