Skip to content

Commit

Permalink
🐛 only support python>=3.10
Browse files Browse the repository at this point in the history
  • Loading branch information
dolittle007 committed Nov 20, 2024
1 parent 6d09722 commit 9a7429f
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 8 deletions.
33 changes: 27 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,34 @@
[![PyPI - Wheel](https://img.shields.io/pypi/wheel/scanitd)](https://pypi.org/project/scanitd/#files)
[![license](https://img.shields.io/pypi/l/scanitd.svg)](https://github.com/ylab-hi/ScanITD/blob/main/LICENSE)

- **PyPI**

```bash
pip install scanitd
```
# 📦 Installation

# Usage
ScanITD can be installed using pip, the Python package installer.
Follow these steps to install:

1. Ensure you have Python 3.10 or later installed on your system.

2. Create a virtual environment (recommended):

```bash
python -m venv scanitd_env
source scanitd_env/bin/activate # On Windows use `scanitd_env\Scripts\activate`
```

3. Install ScanITD:

```bash
pip install scanitd
```

4. Verify the installation:

```bash
scanitd --help
```

# 🛠️ Usage

Usage: scanitd [OPTIONS]

Expand Down Expand Up @@ -67,6 +88,6 @@ pip install scanitd
* `--version`, `-v`
- Show version and exit

# Citation
# 📚 Citation

Wang TY. and Yang R. [ScanITD: Detecting internal tandem duplication with robust variant allele frequency estimation](https://doi.org/10.1093/gigascience/giaa089 "ScanITD: Detecting internal tandem duplication with robust variant allele frequency estimation").
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "scanitd"
version = "0.9.0"
version = "0.9.1"
description = "ScanITD"
authors = [
"Ting-You Wang <[email protected]>",
Expand All @@ -12,10 +12,11 @@ repository = "https://github.com/ylab-hi/ScanITD"
documentation = "https://scanitd.readthedocs.io"
classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3 :: Only"
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
]

[tool.poetry.urls]
Expand Down

0 comments on commit 9a7429f

Please sign in to comment.