Metadata-Version: 2.1
Name: simba_uw_tf_dev
Version: 5.5.9
Summary: Toolkit for computer classification and analysis of behaviors in experimental animals
Home-page: https://github.com/sgoldenlab/simba
Author: Simon Nilsson, Jia Jie Choong, Sophia Hwang
Author-email: sronilsson@gmail.com
License: Modified BSD 3-Clause License
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: arm
Provides-Extra: gpu
License-File: LICENSE
License-File: NOTICE

# SimBA (Simple Behavioral Analysis)
![SimBA Splash](https://raw.githubusercontent.com/sgoldenlab/simba/master/docs/tutorials_rst/img/index/landing_page_1.png)

SimBA (Simple Behavioral Analysis) is a platform for analyzing behaviors of experimental animals within video recordings.

### 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)
- 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 support: [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/)
- Video examples: [http://youtube.com/playlist?list=PLi5Vwf0hhy1R6NDQJ3U28MOUJPfl2YWYl](http://youtube.com/playlist?list=PLi5Vwf0hhy1R6NDQJ3U28MOUJPfl2YWYl)
- Slide examples: [https://simba-uw-tf-dev.readthedocs.io/en/latest/docs/workflow.html](https://simba-uw-tf-dev.readthedocs.io/en/latest/docs/workflow.html)

### Installation
To install SimBA, use the following command:

```bash
pip install simba-uw-tf-dev
```

### Citation
If you use SimBA in your research, please cite:

> Goodwin, N. L., Choong, J. J., Hwang, S., Pitts, K., Bloom, L., Islam, A., Zhang, Y. Y., Szelenyi, E. R., Tong, X., Newman, E. L., Miczek, K., Wright, H. R., McLaughlin, R. J., Norville, Z. C., Eshel, N., Heshmati, M., Nilsson, S. R. O., & Golden, S. A. (2024). Simple Behavioral Analysis (SimBA) as a platform for explainable machine learning in behavioral neuroscience. *Nature Neuroscience*, 27(7), 1411–1424. https://doi.org/10.1038/s41593-024-01649-9

```bibtex
@article{Goodwin_2024,
  title     = {Simple Behavioral Analysis (SimBA) as a platform for explainable machine learning in behavioral neuroscience},
  author    = {Goodwin, Nastacia L. and Choong, Jia J. and Hwang, Sophia and Pitts, Kayla and Bloom, Liana and Islam, Aasiya and Zhang, Yizhe Y. and Szelenyi, Eric R. and Tong, Xiaoyu and Newman, Emily L. and Miczek, Klaus and Wright, Hayden R. and McLaughlin, Ryan J. and Norville, Zane C. and Eshel, Neir and Heshmati, Mitra and Nilsson, Simon R. O. and Golden, Sam A.},
  journal   = {Nature Neuroscience},
  volume    = {27},
  number    = {7},
  pages     = {1411--1424},
  year      = {2024},
  doi       = {10.1038/s41593-024-01649-9},
  url       = {https://doi.org/10.1038/s41593-024-01649-9},
  publisher = {Springer Science and Business Media LLC}
}
```

Other formats (APA, MLA, Chicago, Harvard, Vancouver, RIS) and one-click .bib/.ris downloads: [How to cite SimBA](https://simba-uw-tf-dev.readthedocs.io/en/latest/cite.html).

### Licence
SimBA is licensed under a modified BSD 3-Clause License, permitting use for academic and research purposes only. For commercial licensing inquiries, contact sronilsson@gmail.com.

### Contributors
Contributors on GitHub https://github.com/sgoldenlab/simba#contributors

### Contact
* [Simon N](https://github.com/sronilsson), [sronilsson@gmail.com](mailto:sronilsson@gmail.com)




