Skip to content

Commit

Permalink
Added dependency installation recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
Lilly-May committed Apr 2, 2024
1 parent b8ea72a commit 17a0eb2
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,15 @@ Then, create the conda environment and install the nightly version of panpipes u

```
conda env create --file=pipeline_env.yaml
conda activate pipeline_env
pip install -e .
```

Oxford BMRC Rescomp users find additional advice on the installation [here](https://github.com/DendrouLab/panpipes/blob/main/docs/installation_rescomp.md).

## Releases

Since `panpipes v0.4.0` ,the `ingest` workflow expects different headers for the RNA and Protein modalities from the previous releases.
Since `panpipes v0.4.0`, the `ingest` workflow expects different headers for the RNA and Protein modalities from the previous releases.
Check the example [submission file](https://github.com/DendrouLab/panpipes/blob/main/docs/usage/sample_file_qc_mm.md) and the [documentation](https://panpipes-pipelines.readthedocs.io/en/latest/usage/setup_for_qc_mm.html) for more detailed instructions.

## Citation
Expand Down
4 changes: 3 additions & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Then, create the conda environment and install the nightly version of panpipes u

```
conda env create --file=pipeline_env.yaml
conda activate pipeline_env
pip install -e .
```

#### Option 1.2: Manual conda environment creation
Expand Down Expand Up @@ -72,7 +74,7 @@ pip install 'panpipes[spatial]'
```
The extra `[spatial]` includes squidpy, cell2location, and tangram-sc packages.

##### Nightly versions of panpipes
##### Nightly version of panpipes

If you prefer to use the most recent dev version, install panpipes from Github:

Expand Down

0 comments on commit 17a0eb2

Please sign in to comment.