diff --git a/README.md b/README.md index 461f8d0a0..ea1981982 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ [![Downloads](https://pepy.tech/badge/simba-uw-tf-dev/month)](https://pepy.tech/project/simba-uw-tf-dev) [![Downloads](https://pepy.tech/badge/simba-uw-tf-dev)](https://pepy.tech/project/simba-uw-tf-dev) - +**Manuscript: [Simple Behavioral Analysis (SimBA) as a platform for explainable machine learning in behavioral neuroscience](https://www.nature.com/articles/s41593-024-01649-9)** **Pre-print: [Simple Behavioral Analysis (SimBA) – an open source toolkit for computer classification of complex social behaviors in experimental animals](https://www.biorxiv.org/content/10.1101/2020.04.19.049452v2)**

diff --git a/docs/environment.yml b/docs/environment.yml index 58f983459..e48c4a4f5 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -15,6 +15,8 @@ dependencies: - sphinx-togglebutton==0.3.2 - sphinx_rtd_theme - simba-uw-tf-dev + - sphinx-mathjax-offline + - sphinxemoji - nbsphinx - umap-learn==0.5.2 - pyvis==0.3.2 diff --git a/docs/index.rst b/docs/index.rst index 2ad2c4931..2148a5fb5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,19 +7,31 @@ Welcome to SimBA's documentation! :align: center + These docs are under development. For detailed tutorials, code, and more extensive documentation see the `SimBA GitHub repository `_. For support, see `SimBA Gitter channel `_. -`Pre-print `_ - -**Installation** - +INSTALLATION +------------------------ .. code:: bash pip install simba-uw-tf-dev + +MORE INFORMATION +------------------------ +See below for raison d'être, detailed API, tutorials, data, documentation, support, and walkthroughs: + +- GitHub: [https://github.com/sgoldenlab/simba](https://github.com/sgoldenlab/simba) +- API: [https://simba-uw-tf-dev.readthedocs.io/en/latest/api.html](https://simba-uw-tf-dev.readthedocs.io/en/latest/api.html) +- Gitter Chat: [https://app.gitter.im/#/room/#SimBA-Resource_community:gitter.im](https://app.gitter.im/#/room/#SimBA-Resource_community:gitter.im) +- bioRxiv preprint: [https://www.biorxiv.org/content/10.1101/2020.04.19.049452v2](https://www.biorxiv.org/content/10.1101/2020.04.19.049452v2) +- Nature Neuroscience paper: [https://www.nature.com/articles/s41593-024-01649-9](https://www.nature.com/articles/s41593-024-01649-9) +- Open Science Framework (OSF) data buckets: [https://osf.io/tmu6y/](https://osf.io/tmu6y/) +- Python Package Index (PyPI): [https://pypi.org/project/Simba-UW-tf-dev/](https://pypi.org/project/Simba-UW-tf-dev/) + .. toctree:: :maxdepth: 3 :caption: API REFERENCE: diff --git a/docs/project_description.md b/docs/project_description.md index 16f99a646..061456739 100644 --- a/docs/project_description.md +++ b/docs/project_description.md @@ -10,8 +10,9 @@ See below for raison d'être, detailed API, tutorials, data, documentation, supp - Documentation readthedocs: [https://simba-uw-tf-dev.readthedocs.io/en/latest/](https://simba-uw-tf-dev.readthedocs.io/en/latest/) - API: [https://simba-uw-tf-dev.readthedocs.io/en/latest/api.html](https://simba-uw-tf-dev.readthedocs.io/en/latest/api.html) - Gitter Chat: [https://app.gitter.im/#/room/#SimBA-Resource_community:gitter.im](https://app.gitter.im/#/room/#SimBA-Resource_community:gitter.im) -- biorxiv preprint: [https://www.biorxiv.org/content/10.1101/2020.04.19.049452v2](https://www.biorxiv.org/content/10.1101/2020.04.19.049452v2) -- OSF: [https://osf.io/tmu6y/](https://osf.io/tmu6y/) +- bioRxiv preprint: [https://www.biorxiv.org/content/10.1101/2020.04.19.049452v2](https://www.biorxiv.org/content/10.1101/2020.04.19.049452v2) +- Nature Neuroscience paper: [https://www.nature.com/articles/s41593-024-01649-9](https://www.nature.com/articles/s41593-024-01649-9) +- Open Science Framework (OSF) data buckets: [https://osf.io/tmu6y/](https://osf.io/tmu6y/) ### Installation To install SimBA, use the following command: