|
16 | 16 | :target: https://pypi.org/project/sincei/
|
17 | 17 | :alt: PyPI Version
|
18 | 18 |
|
| 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 | + |
19 | 23 | Bhardwaj V. and Mourragui S. (2023) sincei: A user-friendly toolkit for QC, counting, clustering and plotting of single-cell (epi)genomics data.
|
20 | 24 |
|
21 | 25 |
|
| 26 | +================= |
| 27 | +Installation |
| 28 | +================= |
22 | 29 |
|
| 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. |
23 | 31 |
|
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 |
27 | 46 |
|
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: |
29 | 60 |
|
30 | 61 | .. code-block:: bash
|
31 | 62 |
|
32 | 63 | conda create -n sincei -c anaconda python=3.8
|
33 | 64 | 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 |
35 | 66 |
|
36 | 67 |
|
37 | 68 | Getting Help
|
38 | 69 | ------------
|
39 | 70 |
|
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>`_ |
43 | 72 |
|
| 73 | +**Please Note that sincei is under active development.** We expect significant changes/updates as we move towards our first major release (1.0). |
44 | 74 |
|
45 | 75 |
|
46 | 76 | The list of tools available in sincei
|
|
0 commit comments