Skip to content

Commit a027796

Browse files
committed
add required phrases and clean up installation docs
1 parent c09e454 commit a027796

File tree

2 files changed

+23
-9
lines changed

2 files changed

+23
-9
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,14 @@ You can leave your comments and bug reports at our [GitHub repository tracker](h
7474

7575
* Full IsoQuant documentation is available at [ablab.github.io/IsoQuant](https://ablab.github.io/IsoQuant/).
7676

77-
* IsoQuant can be downloaded from [github.com/ablab/IsoQuant](https://github.com/ablab/IsoQuant) or installed via conda:
77+
* IsoQuant can be downloaded from [github.com/ablab/IsoQuant](https://github.com/ablab/IsoQuant) or installed via conda (typically takes a few minutes):
7878

79-
conda create -c conda-forge -c bioconda -n isoquant python=3.8 isoquant
79+
conda create -c conda-forge -c bioconda -n isoquant python=3.12 isoquant
8080

8181
* If installing manually, you will need Python3 (3.8 or higher), [gffutils](https://pythonhosted.org/gffutils/installation.html), [pysam](https://pysam.readthedocs.io/en/latest/index.html), [pybedtools](https://daler.github.io/pybedtools/), [biopython](https://biopython.org/) and some other common Python libraries to be installed. See `requirements.txt` for details. You will also need to have [minimap2](https://github.com/lh3/minimap2) and [samtools](http://www.htslib.org/download/) to be in your `$PATH` variable.
82+
All required Python libraries can be installed via `pip install -r requirements.txt`.
8283

83-
* Verify your installation by running:
84+
* Verify your installation by running (typically takes less than 1 minute):
8485

8586
isoquant.py --test
8687

docs/installation.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,35 @@
11
# Installation
22

33
IsoQuant requires a 64-bit Linux system or Mac OS and Python (3.8 and higher) to be pre-installed on it.
4+
Note that IsoQuant 3.11.x and earlier versions are not well compatible with Python 3.14.
5+
No special hardware is required.
6+
47
You will also need
58

69
- [gffutils](https://pythonhosted.org/gffutils/installation.html)
710
- [pysam](https://pysam.readthedocs.io/en/latest/index.html)
811
- [pyfaidx](https://pypi.org/project/pyfaidx/)
9-
- [pandas](https://pandas.pydata.org/)
10-
- [pyyaml](https://pypi.org/project/PyYAML/)
12+
- [ssw-py](https://pypi.org/project/ssw-py/)
13+
- [editdistance](https://pypi.org/project/editdistance/)
14+
- [biopython](https://biopython.org/)
15+
- [numba](https://numba.pydata.org/)
1116
- [minimap2](https://github.com/lh3/minimap2)
1217
- [samtools](http://www.htslib.org/download/)
1318
- [STAR](https://github.com/alexdobin/STAR) (optional)
1419

20+
and some other common Python libraries.
21+
The full requirements list can be found in [requirements.txt](https://github.com/ablab/IsoQuant/blob/master/requirements.txt).
22+
23+
1524
## Installing from conda
1625
IsoQuant can be installed with conda:
1726
```bash
18-
conda create -c conda-forge -c bioconda -n isoquant python=3.8 isoquant
27+
conda create -c conda-forge -c bioconda -n isoquant python=3.12 isoquant
1928
```
29+
Typically, conda installation takes a few minutes.
2030

2131
## Installing from GitHub
22-
To obtain IsoQuant you can download repository and install requirements.
32+
To obtain IsoQuant you can download the repository and install the requirements.
2333
Clone IsoQuant repository and switch to the latest release:
2434
```bash
2535
git clone https://github.com/ablab/IsoQuant.git
@@ -30,15 +40,18 @@ Install requirements:
3040
```bash
3141
pip install -r requirements.txt
3242
```
43+
Typically, package installation takes a few minutes.
3344

3445
You also need [samtools](http://www.htslib.org/download/) and [minimap2](https://github.com/lh3/minimap2) to be in the `$PATH` variable.
3546

3647
## Verifying your installation
37-
To verify IsoQuant installation type
48+
To verify IsoQuant installation run
3849
```bash
3950
isoquant.py --test
4051
```
41-
to run on toy dataset.
52+
to run on toy dataset. This should typically take less than 1 minute.
53+
54+
4255
If the installation is successful, you will find the following information at the end of the log:
4356
```bash
4457
=== IsoQuant pipeline finished ===

0 commit comments

Comments
 (0)