Skip to content

BiAPoL/biaplotter

Repository files navigation

biaplotter

License BSD-3 PyPI Python Version tests codecov napari hub

A base napari plotter widget for interactive plotting


This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Documentation

The full documentation with API and examples can be found here.

Installation

  • Make sure you have Python in your computer, e.g. download miniforge.

  • Create a new environment, for example, like this:

mamba create --name biaplotter-env python=3.9

If you never used mamba/conda environments before, take a look at this blog post.

  • Activate the new environment with mamba:
mamba activate biaplotter-env
  • Install napari, e.g. via mamba:
mamba install -c conda-forge napari pyqt

Afterwards, install biaplotter via pip:

pip install biaplotter

To install latest development version :

pip install git+https://github.com/BiAPoL/biaplotter.git

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "biaplotter" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.