Skip to content

Commit

Permalink
Doc cleanup (scverse#2983)
Browse files Browse the repository at this point in the history
  • Loading branch information
flying-sheep authored Apr 22, 2024
1 parent 0370057 commit dbea062
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 60 deletions.
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ repos:
id: ruff
types_or: [python, pyi, jupyter]
args: ["--preview", "--select=PLR0917"]
- repo: https://github.com/flying-sheep/bibfmt
rev: v4.3.0
hooks:
- id: bibfmt
args:
- --sort-by-bibkey
- --drop=abstract
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[![Stars](https://img.shields.io/github/stars/scverse/scanpy?logo=GitHub&color=yellow)](https://github.com/scverse/scanpy/stargazers)
[![Stars](https://img.shields.io/github/stars/scverse/scanpy?style=flat&logo=GitHub&color=yellow)](https://github.com/scverse/scanpy/stargazers)
[![PyPI](https://img.shields.io/pypi/v/scanpy?logo=PyPI)](https://pypi.org/project/scanpy)
[![Downloads](https://static.pepy.tech/badge/scanpy)](https://pepy.tech/project/scanpy)
[![Conda](https://img.shields.io/conda/dn/conda-forge/scanpy?logo=Anaconda)](https://anaconda.org/conda-forge/scanpy)
[![Docs](https://readthedocs.com/projects/icb-scanpy/badge/?version=latest)](https://scanpy.readthedocs.io)
[![Build Status](https://dev.azure.com/scverse/scanpy/_apis/build/status/theislab.scanpy?branchName=main)](https://dev.azure.com/scverse/scanpy/_build)
[![Build Status](https://dev.azure.com/scverse/scanpy/_apis/build/status/scverse.scanpy?branchName=main)](https://dev.azure.com/scverse/scanpy/_build)
[![Discourse topics](https://img.shields.io/discourse/posts?color=yellow&logo=discourse&server=https%3A%2F%2Fdiscourse.scverse.org)](https://discourse.scverse.org/)
[![Chat](https://img.shields.io/badge/zulip-join_chat-%2367b08f.svg)](https://scverse.zulipchat.com)
[![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](https://numfocus.org/)
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```{include} ../README.md
:end-line: 40
:end-before: '## Citation'
```

```{eval-rst}
Expand Down Expand Up @@ -58,8 +58,8 @@ Find a bug? Interested in improving scanpy? Checkout our GitHub for the latest d
## News

```{include} news.md
:start-line: 9
:end-line: 32
:start-after: '<!-- marker: after prelude -->'
:end-before: '<!-- marker: before old news -->'
```

{ref}`(past news) <News>`
Expand Down
17 changes: 2 additions & 15 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,28 +43,16 @@ If you are using `pip>=21.3`, an editable install can be made:
pip install -e '.[dev,test]'
```

For older versions of `pip`, [flit] can be used directly.
To install using symbolic links (stay up to date with your cloned version after you update with `git pull`) call:

```shell
flit install -s --deps=develop # from an activated venv or conda env
# or
flit install -s --deps=develop --python path/to/venv/bin/python
```

If you want to let [conda] handle the installations of dependencies, do:

```shell
pip install beni
pipx install beni
beni pyproject.toml > environment.yml
conda env create -f environment.yml
conda activate scanpy
flit install -s --deps=develop
pip install -e '.[dev,doc,test]'
```

On Windows, you might have to use `flit install --pth-file`
if you are not able to give yourself the [create symbolic links] privilege.

For instructions on how to work with the code, see the {ref}`contribution guide <contribution-guide>`.

## Docker
Expand Down Expand Up @@ -119,7 +107,6 @@ The whole process takes just a couple of minutes.
[compiling igraph]: https://stackoverflow.com/q/29589696/247482
[create symbolic links]: https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links
[docker]: https://en.wikipedia.org/wiki/Docker_(software)
[flit]: https://flit.readthedocs.io/en/latest/
[from pypi]: https://pypi.org/project/scanpy
[gcfntnu/scanpy]: https://hub.docker.com/r/gcfntnu/scanpy
[leiden]: https://leidenalg.readthedocs.io
Expand Down
4 changes: 4 additions & 0 deletions docs/news.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
```

<!-- marker: after prelude -->

### `rapids-singlecell` brings scanpy to the GPU! {small}`2024-03-18`

{doc}`rapids-singlecell <rapids_singlecell:index>` by Severin Dicks provides a scanpy-like API with accelerated operations implemented on GPU.
Expand Down Expand Up @@ -34,6 +36,8 @@ Two large toolkits extending our ecosystem to new modalities have had their manu
* [Muon](https://muon.readthedocs.io/), a framework for multimodal has been published in [Genome Biology](https://genomebiology.biomedcentral.com/articles/10.1186/s13059-021-02577-8).
* [Squidpy](https://squidpy.readthedocs.io/) a toolkit for working with spatial single cell data has been published in [Nature Methods](https://www.nature.com/articles/s41592-021-01358-2).

<!-- marker: before old news -->

### scVelo on the cover of Nature Biotechnology {small}`2020-12-01`

Scanpy's counterpart for RNA velocity, [scVelo](https://scvelo.org/), made it on the cover of [Nature Biotechnology](https://www.nature.com/nbt/volumes/38/issues/12) \[[tweet](https://twitter.com/NatureBiotech/status/1334647540030070792)\].
Expand Down
82 changes: 43 additions & 39 deletions docs/references.bib
Original file line number Diff line number Diff line change
@@ -1,100 +1,104 @@
@inproceedings{luecken2021,
author = {Luecken, Malte and Burkhardt, Daniel and Cannoodt, Robrecht and Lance, Christopher and Agrawal, Aditi and Aliee, Hananeh and Chen, Ann and Deconinck, Louise and Detweiler, Angela and Granados, Alejandro and Huynh, Shelly and Isacco, Laura and Kim, Yang and Klein, Dominik and DE KUMAR, BONY and Kuppasani, Sunil and Lickert, Heiko and McGeever, Aaron and Melgarejo, Joaquin and Mekonen, Honey and Morri, Maurizio and M\"{u}ller, Michaela and Neff, Norma and Paul, Sheryl and Rieck, Bastian and Schneider, Kaylie and Steelman, Scott and Sterr, Michael and Treacy, Daniel and Tong, Alexander and Villani, Alexandra-Chloe and Wang, Guilin and Yan, Jia and Zhang, Ce and Pisco, Angela and Krishnaswamy, Smita and Theis, Fabian and Bloom, Jonathan M},
@inproceedings{Luecken2021,
author = {Luecken, Malte and Burkhardt, Daniel and Cannoodt, Robrecht and Lance, Christopher and Agrawal, Aditi and Aliee, Hananeh and Chen, Ann and Deconinck, Louise and Detweiler, Angela and Granados, Alejandro and Huynh, Shelly and Isacco, Laura and Kim, Yang and Klein, Dominik and De Kumar, Bony and Kuppasani, Sunil and Lickert, Heiko and McGeever, Aaron and Melgarejo, Joaquin and Mekonen, Honey and Morri, Maurizio and M\"{u}ller, Michaela and Neff, Norma and Paul, Sheryl and Rieck, Bastian and Schneider, Kaylie and Steelman, Scott and Sterr, Michael and Treacy, Daniel and Tong, Alexander and Villani, Alexandra-Chloe and Wang, Guilin and Yan, Jia and Zhang, Ce and Pisco, Angela and Krishnaswamy, Smita and Theis, Fabian and Bloom, Jonathan M},
editor = {Vanschoren, J. and Yeung, S.},
booktitle = {Proceedings of the Neural Information Processing Systems Track on Datasets and Benchmarks},
editor = {J. Vanschoren and S. Yeung},
pages = {},
publisher = {Curran},
title = {A sandbox for prediction and integration of DNA, RNA, and proteins in single cells},
url = {https://datasets-benchmarks-proceedings.neurips.cc/paper_files/paper/2021/file/158f3069a435b314a80bdcb024f8e422-Paper-round2.pdf},
volume = {1},
year = {2021}
year = {2021},
}

@article{McCarthy2017,
author = {McCarthy, Davis J and Campbell, Kieran R and Lun, Aaron T L and Wills, Quin F},
editor = {Hofacker, Ivo},
doi = {10.1093/bioinformatics/btw777},
url = {https://doi.org/10.1093/bioinformatics/btw777},
year = {2017},
month = jan,
month = {jan},
publisher = {Oxford University Press ({OUP})},
volume = {33},
number = {8},
pages = {1179--1186},
author = {Davis J McCarthy and Kieran R Campbell and Aaron T L Lun and Quin F Wills},
editor = {Ivo Hofacker},
title = {Scater: pre-processing, quality control, normalization and visualization of single-cell {RNA}-seq data in R},
journal = {Bioinformatics}
title = {Scater: pre-processing, quality control, normalization and visualization of single-cell {RNA}-seq data in R},
journal = {Bioinformatics},
}

@article{Satija2015,
author = {Satija, Rahul and Farrell, Jeffrey A and Gennert, David and Schier, Alexander F and Regev, Aviv},
doi = {10.1038/nbt.3192},
url = {https://doi.org/10.1038/nbt.3192},
year = {2015},
month = apr,
month = {apr},
publisher = {Springer Science and Business Media {LLC}},
volume = {33},
number = {5},
pages = {495--502},
author = {Rahul Satija and Jeffrey A Farrell and David Gennert and Alexander F Schier and Aviv Regev},
title = {Spatial reconstruction of single-cell gene expression data},
journal = {Nature Biotechnology}
journal = {Nature Biotechnology},
}
@article{stuart2019comprehensive,
title = {Comprehensive integration of single-cell data},

@article{Stuart2019,
author = {Stuart, Tim and Butler, Andrew and Hoffman, Paul and Hafemeister, Christoph and Papalexi, Efthymia and Mauck, William M and Hao, Yuhan and Stoeckius, Marlon and Smibert, Peter and Satija, Rahul},
title = {Comprehensive integration of single-cell data},
journal = {Cell},
volume = {177},
number = {7},
pages = {1888--1902},
year = {2019},
publisher = {Elsevier}
publisher = {Elsevier},
}
@article{traag2019louvain,
title = {From Louvain to Leiden: guaranteeing well-connected communities},

@article{Traag2019,
author = {Traag, Vincent A and Waltman, Ludo and Van Eck, Nees Jan},
title = {From Louvain to Leiden: guaranteeing well-connected communities},
journal = {Scientific reports},
volume = {9},
number = {1},
pages = {5233},
year = {2019},
publisher = {Nature Publishing Group UK London}
publisher = {Nature Publishing Group UK London},
}

@article{Wolf2018,
author = {Wolf, F. Alexander
and Angerer, Philipp
and Theis, Fabian J.},
title = {SCANPY: large-scale single-cell gene expression data analysis},
journal = {Genome Biology},
year = {2018},
month = {Feb},
day = {06},
volume = {19},
number = {1},
pages = {15},
abstract = {Scanpy is a scalable toolkit for analyzing single-cell gene expression data. It includes methods for preprocessing, visualization, clustering, pseudotime and trajectory inference, differential expression testing, and simulation of gene regulatory networks. Its Python-based implementation efficiently deals with data sets of more than one million cells (https://github.com/theislab/Scanpy). Along with Scanpy, we present AnnData, a generic class for handling annotated data matrices (https://github.com/theislab/anndata).},
issn = {1474-760X},
doi = {10.1186/s13059-017-1382-0},
url = {https://doi.org/10.1186/s13059-017-1382-0}
author = {Wolf, F. Alexander and Angerer, Philipp and Theis, Fabian J.},
title = {SCANPY: large-scale single-cell gene expression data analysis},
journal = {Genome Biology},
year = {2018},
month = {feb},
day = {06},
volume = {19},
number = {1},
pages = {15},
issn = {1474-760X},
doi = {10.1186/s13059-017-1382-0},
url = {https://doi.org/10.1186/s13059-017-1382-0},
}

@article{Wolock2019,
author = {Wolock, Samuel L. and Lopez, Romain and Klein, Allon M.},
doi = {10.1016/j.cels.2018.11.005},
url = {https://doi.org/10.1016/j.cels.2018.11.005},
year = {2019},
month = apr,
month = {apr},
publisher = {Elsevier {BV}},
volume = {8},
number = {4},
pages = {281--291.e9},
author = {Samuel L. Wolock and Romain Lopez and Allon M. Klein},
title = {Scrublet: Computational Identification of Cell Doublets in Single-Cell Transcriptomic Data},
journal = {Cell Systems}
journal = {Cell Systems},
}

@article{Zheng2017,
author = {Zheng, Grace X. Y. and Terry, Jessica M. and Belgrader, Phillip and Ryvkin, Paul and Bent, Zachary W. and Wilson, Ryan and Ziraldo, Solongo B. and Wheeler, Tobias D. and McDermott, Geoff P. and Zhu, Junjie and Gregory, Mark T. and Shuga, Joe and Montesclaros, Luz and Underwood, Jason G. and Masquelier, Donald A. and Nishimura, Stefanie Y. and Schnall-Levin, Michael and Wyatt, Paul W. and Hindson, Christopher M. and Bharadwaj, Rajiv and Wong, Alexander and Ness, Kevin D. and Beppu, Lan W. and Deeg, H. Joachim and McFarland, Christopher and Loeb, Keith R. and Valente, William J. and Ericson, Nolan G. and Stevens, Emily A. and Radich, Jerald P. and Mikkelsen, Tarjei S. and Hindson, Benjamin J. and Bielas, Jason H.},
doi = {10.1038/ncomms14049},
url = {https://doi.org/10.1038/ncomms14049},
year = {2017},
month = jan,
month = {jan},
publisher = {Springer Science and Business Media {LLC}},
volume = {8},
number = {1},
author = {Grace X. Y. Zheng and Jessica M. Terry and Phillip Belgrader and Paul Ryvkin and Zachary W. Bent and Ryan Wilson and Solongo B. Ziraldo and Tobias D. Wheeler and Geoff P. McDermott and Junjie Zhu and Mark T. Gregory and Joe Shuga and Luz Montesclaros and Jason G. Underwood and Donald A. Masquelier and Stefanie Y. Nishimura and Michael Schnall-Levin and Paul W. Wyatt and Christopher M. Hindson and Rajiv Bharadwaj and Alexander Wong and Kevin D. Ness and Lan W. Beppu and H. Joachim Deeg and Christopher McFarland and Keith R. Loeb and William J. Valente and Nolan G. Ericson and Emily A. Stevens and Jerald P. Radich and Tarjei S. Mikkelsen and Benjamin J. Hindson and Jason H. Bielas},
title = {Massively parallel digital transcriptional profiling of single cells},
journal = {Nature Communications}
journal = {Nature Communications},
}
2 changes: 1 addition & 1 deletion notebooks

0 comments on commit dbea062

Please sign in to comment.