Installation

The easy way

The currently default way to install GrowBikeNet is using conda (or the faster mamba) via the conda-forge channel:

conda install -c conda-forge growbikenet

For more installation options, see below.

With pip

GrowBikeNet can also be installed with pip, if all dependencies can be installed as well:

pip install growbikenet

Warning

We do not recommend using pip, because you need to make sure that all dependencies of growbikenet are installed correctly. Using conda (see above) avoids the need to compile the dependencies yourself.

Environment installations

Creating a new environment is not strictly necessary, but given that installing other geospatial packages from different channels may cause dependency conflicts, it can be good practice to install in a clean environment starting fresh.

The main step is to set up a virtual environment gbnenv in which to install the package, and then to use or run the environment. Use either of the methods below.

With conda

Installation with conda (or the faster mamba). The following commands create the gbnenv environment, configures it to install packages always from conda-forge, and installs GrowBikeNet in it:

conda create -n gbnenv
conda activate gbnenv
conda config --env --add channels conda-forge
conda config --env --set channel_priority strict
conda install python=3 growbikenet

Run growbikenet in Jupyter lab

After having set up the environment above, if you wish to run growbikenet via JupyterLab, follow the corresponding instructions below.

With conda

Using conda (or the faster mamba), run:

conda activate gbnenv
ipython kernel install --user --name=gbnenv
conda deactivate
jupyter lab

Once Jupyter lab opens, switch the kernel (Kernel > Change Kernel > gbnenv)

With pip

Using pip, run:

pip install --user ipykernel
python -m ipykernel install --user --name=gbnenv
jupyter lab

Once Jupyter lab opens, switch the kernel (Kernel > Change Kernel > gbnenv)

Development installation

If you want to develop the project, clone this repository and create the environment via Pixi and the environment-dev.yml file:

pixi init --import environment-dev.yml

The development environment is called gbnenvdev. At this point you can run growbikenet in the environment, for example as such:

pixi run python examples/mwe.py

Note

The first time you run code with Pixi, it might take a minute longer, as Pixi resolves the environment’s dependencies only at this point.

Alternatively, start a pixi shell:

pixi shell

Make sure to also read our contribution guidelines.