Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ repos:
- id: nbstripout
exclude: |
(?x)(
docs/examples/|
docs/notes/
docs/examples/
)
- repo: https://github.com/Lucas-C/pre-commit-hooks
rev: v1.1.9
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This package provides efficient and scalable handling of flow and mass cytometry
- access to the entire [scanpy](https://scanpy.readthedocs.io/en/stable/) workflow functionality
- GPU support through [rapids](https://github.com/clara-parabricks/rapids-single-cell-examples)

Follow [https://twitter.com/marenbuettner](https://twitter.com/marenbuettner) to learn about a first public release.
Follow [https://twitter.com/marenbuettner](https://twitter.com/marenbuettner) for updates.

For the code enthusiasts: Find our code base on [Github](https://github.com/buettnerlab/pytometry).

Expand All @@ -32,6 +32,10 @@ or from GitHub:
pip install git+https://github.com/buettnerlab/pytometry.git
```

## Updates

- October 12th 2022: First public release announcement on [Twitter](https://twitter.com/marenbuettner/status/1580160765201244161?s=20&t=mTBLcUaqKs9eMzEpOWnG0g)

## Citation

Pytometry is currently a pre-print on [bioRxiv](https://www.biorxiv.org/content/10.1101/2022.10.10.511546v1).
60 changes: 0 additions & 60 deletions docs/guides/curate-data.ipynb

This file was deleted.

9 changes: 0 additions & 9 deletions docs/guides/index.md

This file was deleted.

4 changes: 1 addition & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
```{include} ../README.md
:start-line: 0
:end-line: 38
:end-line: 42
```

```{toctree}
Expand All @@ -10,7 +10,5 @@
tutorials/index
api
examples/index
guides/index
notes/index
changelog
```
43 changes: 0 additions & 43 deletions docs/notes/YYYY-MM-DD-my-design-choice.ipynb

This file was deleted.

11 changes: 0 additions & 11 deletions docs/notes/index.md

This file was deleted.

6 changes: 1 addition & 5 deletions docs/tutorials/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Tutorials

A step-wise pedagogic tutorial including a quickstart. The notebooks get executed in CI for testing.

Ideally, each feature is explained in a separate clean notebook.

This makes it both easy for the user to understand the documentation, and for the developer to increase test coverage.
These tutorials show how to use the pytometry functionality.

```{toctree}
:maxdepth: 1
Expand Down
1 change: 0 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ preview = true
[tool.pytest.ini_options]
testpaths = [
"tests",
"docs/guides",
"docs/tutorials",
]

Expand Down