Skip to content

Commit

Permalink
update installation instructions and add link to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zoccoler committed May 3, 2024
1 parent ab90104 commit 906657c
Showing 1 changed file with 31 additions and 3 deletions.
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,45 @@ and review the napari docs for plugin developers:
https://napari.org/stable/plugins/index.html
-->

## Documentation

The full documentation with API and examples can be found [here](https://biapol.github.io/biaplotter/).

## Installation

You can install `biaplotter` via [pip]:
* Make sure you have Python in your computer, e.g. download [miniforge](https://github.com/conda-forge/miniforge?tab=readme-ov-file#download).

* 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](https://biapol.github.io/blog/mara_lampert/getting_started_with_mambaforge_and_python/readme.html).

* **Activate** the new environment with `mamba`:

```
mamba activate biaplotter-env
```

* Install [napari](https://napari.org/stable/), e.g. via `mamba`:

pip install biaplotter
```
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
```
pip install git+https://github.com/BiAPoL/biaplotter.git
```


## Contributing
Expand Down

0 comments on commit 906657c

Please sign in to comment.