Skip to content

Commit

Permalink
update to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bio-la committed Mar 6, 2024
1 parent 1637535 commit ad4e056
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,26 @@ Available workflows:

See [installation instructions here](https://panpipes-pipelines.readthedocs.io/en/latest/install.html)

We recommend installing panpipes in a conda environment, we provide a minimal conda config file in `pipeline_env.yaml`

```
conda env create --file=pipeline_env.yml
```

In this environment, you can install nightly version of panpipes, i.e. cloning this repo and installing it from main.

```
git clone https://github.com/DendrouLab/panpipes.git
cd panpipes
pip install -e .
```


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

## Releases

`panpipes v0.4.0` is out [now](./CHANGELOG.md)!

The `ingest` workflow now expects different headers for the RNA and Protein modalities.
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 All @@ -45,4 +58,4 @@ bioRxiv 2023.03.11.532085; doi: https://doi.org/10.1101/2023.03.11.532085](https
## Contributors

Created and Maintained by Charlotte Rich-Griffin and Fabiola Curion.
Additional contributors: Sarah Ouologuem, Devika Agarwal, Lilly May, Kevin Rue-Albrecht, Lukas Heumos.
Additional contributors: Sarah Ouologuem, Devika Agarwal, Lilly May, Kevin Rue-Albrecht, Giulia Garcia, Lukas Heumos.

0 comments on commit ad4e056

Please sign in to comment.