Skip to content

Commit bf7ca49

Browse files
committed
update install instructions
1 parent 2cc06e5 commit bf7ca49

File tree

2 files changed

+27
-13
lines changed

2 files changed

+27
-13
lines changed

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,26 @@ but can also be used independently.
1717

1818
## Installation
1919

20-
`spatialleiden` will be made available on [PyPI](https://pypi.org/) and
21-
[bioconda](https://bioconda.github.io/). For detailed installation instructions
22-
please refer to the [documentation](https://spatialleiden.readthedocs.io/en/stable/installation.html).
20+
`spatialleiden` is available on [PyPI](https://pypi.org/project/spatialleiden/) and
21+
[bioconda](https://bioconda.github.io/recipes/spatialleiden/README.html).
22+
23+
```sh
24+
# PyPI
25+
pip install spatialleiden
26+
```
27+
28+
```sh
29+
# or conda
30+
conda install bioconda::spatialleiden
31+
```
32+
33+
For detailed installation instructions please refer to the
34+
[documentation](https://spatialleiden.readthedocs.io/en/stable/installation.html).
2335

2436
## Documentation
2537

26-
For documentation of the package please refer to the [ReadTheDocs page](https://spatialleiden.readthedocs.io/)
38+
For documentation of the package please refer to the
39+
[ReadTheDocs page](https://spatialleiden.readthedocs.io/).
2740

2841
## Versioning
2942

docs/source/installation.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Installation
55
PyPi and ``pip``
66
----------------
77

8-
To install ``spatialleiden`` from `PyPI <https://pypi.org/>`_ using ``pip`` just run
8+
To install ``spatialleiden`` from `PyPI <https://pypi.org/project/spatialleiden/>`_
9+
using ``pip`` just run
910

1011
.. code-block:: bash
1112
@@ -15,19 +16,19 @@ To install ``spatialleiden`` from `PyPI <https://pypi.org/>`_ using ``pip`` just
1516
bioconda and ``conda``
1617
----------------------
1718

18-
``spatialleiden`` is not yet available for
19-
`Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_ installations. But we are
20-
planning to add it to `bioconda <https://bioconda.github.io/>`_ soon.
19+
``spatialleiden`` is available for `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_
20+
installations from the `bioconda <https://bioconda.github.io/recipes/spatialleiden/README.html>`_
21+
channel.
2122

2223

23-
.. .. code-block:: bash
24+
.. code-block:: bash
2425
25-
.. conda install -c conda-forge spatialleiden
26+
conda install bioconda::spatialleiden
2627
27-
.. .. note::
28+
.. note::
2829

29-
.. Of course, it is also possible to use ``mamba`` instead of ``conda``
30-
.. to speed up the installation.
30+
Of course, it is also possible to use ``mamba`` instead of ``conda``
31+
to speed up the installation.
3132

3233

3334
From GitHub

0 commit comments

Comments
 (0)