Skip to content

Commit 912ce47

Browse files
committed
Update package information and installation guide
1 parent eac06be commit 912ce47

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212

1313
## About
1414

15-
This is a work in progress for CyTOF DR analyses and evaluation.
15+
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
16+
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!
1617

1718
## Installation
1819

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

3435
```shell
35-
conda install -c kevin931 cytofdr -c conda-forge -c bioconda
36+
conda install -c kevin931 cytofdr -c conda-forge -c bioconda
3637
```
3738
The core dependencies should automatically install!
3839

docs/source/installation.rst

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,29 @@ a one-stop solution. Follow the guide here to get started!
1111
Conda
1212
***********
1313

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

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

1926
***********
2027
PyPI
2128
***********
2229

23-
We plan on releasing this package on ``PyPI``. Stay tuned!
30+
Our package is also on ``PyPI``, which you can easily install with the following command:
31+
32+
.. code-block:: shell
33+
34+
pip install CytofDR
35+
36+
And voila, that's it!
2437

2538
---------
2639

0 commit comments

Comments
 (0)