Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
moinfar committed Nov 6, 2024
1 parent 8d3ad01 commit f518d0e
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 9 deletions.
3 changes: 3 additions & 0 deletions .github/misc/concept.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,19 @@

Unsupervised Deep Disentangled Representation of Single-Cell Omics

<h1 align="center">
<picture>
<source srcset=".github/misc/concept.svg">
<img width="800" src=".github/misc/concept.svg" alt="DRVI concept">
</picture>
</h1>

## Getting started

Please refer to the [documentation][link-docs]. In particular, the

- [API documentation][link-api].
- [Tutorials][link-tutorials]

## Installation

Expand Down Expand Up @@ -42,23 +50,22 @@ See the [changelog][changelog].

## Contact

[//]: # (TODO: make clear where to ask questions:)
[//]: # (For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].)
[//]: # "TODO: make clear where to ask questions:"
[//]: # "For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse]."

If you found a bug, please use the [issue tracker][issue-tracker].

## Citation

> t.b.a
## Contributing
If DRVI is helpful in your research, please consider citing the following paper:

## Authors and acknowledgment
> t.b.a
## License


[issue-tracker]: https://github.com/theislab/drvi/issues
[changelog]: https://drvi.readthedocs.io/latest/changelog.html
[link-docs]: https://drvi.readthedocs.io
[link-api]: https://drvi.readthedocs.io/latest/api.html
[link-tutorials]: https://drvi.readthedocs.io/latest/tutorials.html
[link-pypi]: https://pypi.org/project/drvi-py
3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,5 @@ api/index.md
changelog.md
contributing.md
references.md
notebooks/general_pipeline
tutorials.md
```
2 changes: 2 additions & 0 deletions docs/references.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# References

If DRVI is helpful in your research, please consider citing the following paper:

```{bibliography}
:cited:
```
7 changes: 7 additions & 0 deletions docs/tutorials.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Tutorials

```{toctree}
:maxdepth: 2
notebooks/general_pipeline
```

0 comments on commit f518d0e

Please sign in to comment.