Skip to content

Commit

Permalink
links in toml and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ktpolanski committed Aug 1, 2023
1 parent 7ef600a commit 0d7a800
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
## Installation

```bash
pip install git+https://github.com/Teichlab/sctk.git
pip install sctk
```

It is recommended to install sctk into a fresh python 3.9 virtual environment due to its large amount of dependencies. If you encounter a dependency conflict when installing into a fresh environment, try updating pip:
If you encounter dependency clashes, create a fresh python 3.9 virtual environment (e.g. via conda) and install SCTK there. It may also help to update pip:

```bash
pip install --upgrade pip
```

## Usage
## Usage and Documentation

An example of applying the automatic QC workflow can be found in the [demo notebook](notebooks/automatic_qc.ipynb).
SCTK's documentation is available [here](https://teichlab.github.io/sctk/), and features a tutorial and API reference for the automated QC workflow.
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ authors = [
]
license = "GPL-3.0"
readme = "README.md"
homepage = "https://github.com/Teichlab/sctk"
documentation = "https://teichlab.github.io/sctk/"

[tool.poetry.dependencies]
python = "^3.9"
Expand Down

0 comments on commit 0d7a800

Please sign in to comment.