Skip to content

Commit

Permalink
Update package information and installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin931 committed Jun 4, 2022
1 parent eac06be commit 912ce47
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@

## About

This is a work in progress for CyTOF DR analyses and evaluation.
CytofDR is a framework of dimension reduction (DR) and its evaluation for both Cytometry by Time-of-Flight (CyTOF) and general-purpose usages. It allows you to
conveniently run many different DRs at one place and then evaluate them to pick your embedding using our extensive evaluation framework! We aim to provide you with a reliable, extensible, and convenient interface for all your DR needs for both data analyses and future research!

## Installation

Expand All @@ -32,7 +33,7 @@ I personally recommend using ``conda`` to install everything since it's so easy
To install the package with ``conda``:

```shell
conda install -c kevin931 cytofdr -c conda-forge -c bioconda
conda install -c kevin931 cytofdr -c conda-forge -c bioconda
```
The core dependencies should automatically install!

Expand Down
19 changes: 16 additions & 3 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,29 @@ a one-stop solution. Follow the guide here to get started!
Conda
***********

We plan on releasing this package on ``conda``. Stay tuned!
We are officially on ``conda``!! This is actually our recommended way of installing and running
``CytofDR``. To install, simply run the following:

.. code-block:: shell
---------
conda install -c kevin931 cytofdr -c conda-forge -c bioconda
If you need to learn more about how to create and manage conda environments, you can take a look
at their `documentation <https://docs.anaconda.com/anaconda/install/>`_.

-----------------

***********
PyPI
***********

We plan on releasing this package on ``PyPI``. Stay tuned!
Our package is also on ``PyPI``, which you can easily install with the following command:

.. code-block:: shell
pip install CytofDR
And voila, that's it!

---------

Expand Down

0 comments on commit 912ce47

Please sign in to comment.