Skip to content

Commit a4fe325

Browse files
committed
updated install instructions
1 parent b893562 commit a4fe325

File tree

2 files changed

+45
-15
lines changed

2 files changed

+45
-15
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## sincei: A user-friendly toolkit for QC, counting, clustering and plotting of single-cell (epi)genomics data.
66

7-
[![DOI](https://zenodo.org/badge/271841139.svg)](https://zenodo.org/badge/latestdoi/271841139) [![Documentation Status](https://readthedocs.org/projects/sincei/badge/?version=latest)](https://sincei.readthedocs.io/en/latest/?badge=latest) [![PyPI Version](https://img.shields.io/pypi/v/sincei.svg?style=plastic)](https://pypi.org/project/sincei/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![test](https://github.com/vivekbhr/sincei/actions/workflows/test.yml/badge.svg)](https://github.com/vivekbhr/sincei/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/vivekbhr/sincei/graph/badge.svg?token=VRTMITHHBI)](https://codecov.io/gh/vivekbhr/sincei)
7+
[![DOI](https://zenodo.org/badge/271841139.svg)](https://zenodo.org/badge/latestdoi/271841139) [![Documentation Status](https://readthedocs.org/projects/sincei/badge/?version=latest)](https://sincei.readthedocs.io/en/latest/?badge=latest) [![PyPI Version](https://img.shields.io/pypi/v/sincei.svg?style=plastic)](https://pypi.org/project/sincei/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![test](https://github.com/vivekbhr/sincei/actions/workflows/test.yml/badge.svg)](https://github.com/vivekbhr/sincei/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/vivekbhr/sincei/graph/badge.svg?token=VRTMITHHBI)](https://codecov.io/gh/vivekbhr/sincei) [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/sincei/README.html)
88

99
## Features
1010

@@ -23,18 +23,18 @@ Please browse the full documentation for tutorials on how to use sincei on comma
2323

2424
sincei is a command line toolkit based on python3, and can be installed using [conda](https://conda.io/projects/conda/en/latest/user-guide/install/index.html).
2525

26-
Create a new conda environment and install sincei stable release from github using:
26+
The recommended way to install sincei is via bioconda:
2727

2828
```
29-
conda create -n sincei -c anaconda python=3.8
30-
conda activate sincei
31-
(sincei): pip install --editable=git+https://github.com/vivekbhr/sincei.git@master#egg=sincei
29+
conda create -n sincei -c bioconda -c conda-forge sincei
3230
```
3331

34-
For the development version, try:
32+
Alternatively, a development version can be installed via GitHub.
3533

3634
```
37-
(sincei): pip install --editable=git+https://github.com/vivekbhr/sincei.git@develop#egg=sincei
35+
conda create -n sincei -c anaconda python=3.8
36+
conda activate sincei
37+
(sincei): pip install --editable=git+https://github.com/bhardwaj-lab/sincei.git@master#egg=sincei
3838
```
3939

4040
## Usage

docs/index.rst

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,31 +16,61 @@
1616
:target: https://pypi.org/project/sincei/
1717
:alt: PyPI Version
1818

19+
.. image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
20+
:target: http://bioconda.github.io/recipes/sincei/README.html
21+
:alt: Install with bioconda
22+
1923
Bhardwaj V. and Mourragui S. (2023) sincei: A user-friendly toolkit for QC, counting, clustering and plotting of single-cell (epi)genomics data.
2024

2125

26+
=================
27+
Installation
28+
=================
2229

30+
sincei is a command line toolkit based on python3. The stable version of sincei can be installed using `conda <https://conda.io/projects/conda/en/latest/user-guide/install/index.html>`_ , while the development versions can be installed from github via pip.
2331

24-
Installation
25-
-------------------
26-
sincei is a command line toolkit based on python3, and can be installed using `conda <https://conda.io/projects/conda/en/latest/user-guide/install/index.html>`_
32+
Installation via bioconda
33+
---------------------------
34+
35+
Create a new conda environment and install sincei in it using:
36+
37+
.. code-block:: bash
38+
39+
conda create -n sincei -c bioconda -c conda-forge sincei
40+
41+
Users of Mac with Arm architecture (M1-3 macbooks and beyond) should explicitly specify the osx-64 version to allow dependencies to install properly.
42+
43+
.. code-block:: bash
44+
45+
conda create -n sincei --subdir 'osx-64' -c bioconda -c conda-forge sincei
2746
28-
Create a new conda environment and install sincei using:
47+
*Note:* The dependency `mctorch-lib` required for `scClusterCells` is currently unavailable via conda, therefore, to use `scClusterCells`, we recommend installing it separately via pip.
48+
49+
.. code-block:: bash
50+
51+
# install mctorch-lib
52+
(sincei): pip install mctorch-lib
53+
(sincei): scClusterCells --help
54+
55+
56+
Installation via github
57+
---------------------------
58+
59+
Create a new conda environment and install sincei in it using pip from GitHub:
2960

3061
.. code-block:: bash
3162
3263
conda create -n sincei -c anaconda python=3.8
3364
conda activate sincei
34-
(sincei): pip install git+https://github.com/vivekbhr/sincei.git@master#egg=sincei
65+
(sincei): pip install git+https://github.com/bhardwaj-lab/sincei.git@master#egg=sincei
3566
3667
3768
Getting Help
3869
------------
3970

40-
* For all kind of questions, suggesting changes/enhancements or to report bugs, please create an issue on `our GitHub repository <https://github.com/vivekbhr/sincei>`_
41-
42-
**Please Note that sincei is under active development.** Some features might be incomplete, untested or might be removed as we move towards a stable version.
71+
* For questions related to usage, or suggesting changes/enhancements please use our `GitHub discussion board <https://github.com/bhardwaj-lab/sincei/discussions>`__ . To report bugs, please create an issue on `our GitHub repository <https://github.com/bhardwaj-lab/sincei>`_
4372

73+
**Please Note that sincei is under active development.** We expect significant changes/updates as we move towards our first major release (1.0).
4474

4575

4676
The list of tools available in sincei

0 commit comments

Comments
 (0)