Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add conda installation info #399

Merged
merged 2 commits into from Apr 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
Expand Up @@ -26,8 +26,10 @@
<td>Version Info</td>
<td>
<a href="https://pypi.org/project/histolab/" target="_blank"><img src="https://img.shields.io/pypi/v/histolab"></a>
<a href="https://anaconda.org/conda-forge/histolab"> <img src="https://anaconda.org/conda-forge/histolab/badges/version.svg" /> </a>
<img src="https://img.shields.io/pypi/pyversions/histolab">
<img src="https://img.shields.io/pypi/wheel/histolab">

</td>
</tr>
<tr>
Expand Down Expand Up @@ -56,7 +58,7 @@

## Table of Contents

* [Motivation](#motivation)
- [Motivation](#motivation)

- [Quickstart](#quickstart)
- [TCGA data](#tcga-data)
Expand All @@ -65,13 +67,13 @@
- [Random Extraction](#random-extraction)
- [Grid Extraction](#grid-extraction)
- [Score-based extraction](#score-based-extraction)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Roadmap](#roadmap)
- [Acknowledgements](#acknowledgements)
- [References](#references)
- [Contribution guidelines](#contribution-guidelines)
- [Versioning](#versioning)
- [Authors](#authors)
- [License](#license)
- [Roadmap](#roadmap)
- [Acknowledgements](#acknowledgements)
- [References](#references)
- [Contribution guidelines](#contribution-guidelines)


## Motivation
Expand Down Expand Up @@ -122,6 +124,12 @@ it can be easily installed via the command:
pip install histolab
```

alternatively, it can be installed via conda:

```
conda install -c conda-forge histolab
```

## TCGA data

First things first, let’s import some data to work with, for example the
Expand Down
7 changes: 7 additions & 0 deletions docs/quickstart.rst
Expand Up @@ -20,6 +20,13 @@ the ``histolab`` package has been published on

pip install histolab

alternatively, it can be installed via conda:

.. prompt:: text
:prompts: $

conda install -c conda-forge histolab

TCGA data
---------

Expand Down
7 changes: 6 additions & 1 deletion docs/readme.rst
Expand Up @@ -39,11 +39,16 @@ smaller regions of tissues (tiles), which in turns require a tissue detection st
Installation
************

The histolab package can be installed by using::
The histolab package can be installed via pip::

pip install histolab


or via conda::

conda install -c conda-forge histolab


Prerequisites
*************
Please see `installation instructions <installation.html>`_.
Expand Down