Installation¶

For users¶

The package works with Python 3.10+ and can be installed from both PyPI and/or conda-forge.

To install the package using the pip package manager, run the following command:

$ pip install blop

To install the package using the conda package manager, run the following command:

$ conda install -c conda-forge blop

You have the option of running the tutorials in Jupyter Lab locally or in a browser using Binder.

If you are using Pixi (see For developers below), you can do the following for a local Jupyter Lab instance:

$ pixi run start-jupyter

Your third option is to simply convert the tutorials to ipynb format and use whatever you prefer to run them.

$ jupytext --to ipynb docs/source/tutorials/*.md

We recommend using Pixi to manage your development environments. Go to https://pixi.sh/latest/installation/ to install it.

If you don’t want to use Pixi, you can view the configuration in the pixi.toml file and create your own based on it.

For linting, formatting, and static code analysis.

$ pixi run check

For running the tests.

$ pixi run unit-tests
$ pixi run test-docs

For building this documentation.

$ pixi run build-docs