Installation#

Installing#

There are several ways to install deadleaves. For most usecases we recommend installing from PyPI using pip.

To adapt or contribute code, you will have to get the source code from GitHub.

You may install deadleaves from PyPI using pip:

pip install deadleaves

Install a different version

pip by default install the latest version of the package. To install a different version, simply specify the version number, either an exact version:

pip install "deadleaves==0.1.1"

or a conditional version:

pip install "deadleaves<=1.0.0"

(for any version before 1.0.0).

  1. Clone the repository from GitHub:

    git clone git@github.com/ag-perception-wallis-lab/deadleaves.git

  2. Install deadleaves to your local python library using pip, by running from the top-level directory:

    pip install .

For developers

pip install -e .dev

for an editable install (-e) which makes changes to files immediately usable, rather than having to reinstall the package after every change; and to install the development dependencies.

Dependencies#

We recommend using a Python version 3.12 or newer. The dependencies should be automatically installed (at least using pip). deadleavess required dependencies are:

Note

If possible we advise to setup CUDA for GPU use. On CPU sampling a single high-resolution image may take multiple minutes.