Skip to content

Commit

Permalink
Merge pull request #1 from Fluorescence-Tools/development
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
tpeulen authored Feb 16, 2024
2 parents 8b98561 + 82dd84d commit 098d7ef
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,24 +28,25 @@ k2dist
```

### Conda
``k2dist`` depends on common python packages such as ``numpy``. Additionally, ``k2dist`` depends on
``scikit-fluorescence``. Thus, to install ``k2dist`` make sure that conda channels that provide packages for the necessary
dependencies are listed in the ``.condarc`` file

```yaml
channels:
- salilab
- tpeulen
- tpeulen/label/nightly
- conda-forge
- defaults
``k2dist`` depends on common python packages that can be installed from conda-forge.
The easiest installation path is using conda/mamba

```bash
mamba install k2dist -c tpeulen
```

To avoid potential conflicts ``k2dist`` can be installed in a separate environment.

```bash
conda env create -n k2dist
conda activate k2dist
mamba install k2dist -c tpeulen
```

`k2dist` can be started from the command line as follows:

```commandline
conda create -n test
conda install k2dist
k2dist
```


Expand Down
2 changes: 1 addition & 1 deletion conda-recipe/meta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ test:
imports:
- k2dist
commands:
- k2dist & # [linux or osx]
- k2dist & # [linux]

about:
home: {{ data.get('url') }}
Expand Down

0 comments on commit 098d7ef

Please sign in to comment.