📖 Welcome to SimBA’s documentation!

Note

These docs are under development. For detailed tutorials, code, and more extensive documentation see the SimBA GitHub repository.

If you find any of the codebase or associated documentation useful, please cite us.

For support, see the SimBA Gitter channel.

For a high-level overview of SimBA’s raison d’être, use cases, background, and key functions — aimed at behavioral scientists — see this video.

🚀 INSTALLATION

To install SimBA via pip, use the following command (preferably using python3.6, or python 3.10 if necessary):

pip install simba-uw-tf-dev

For detailed installation instructions via pip, click HERE or HERE.

For detailed installation instructions via Anaconda Navigator, click HERE or HERE.

📑 HOW TO CITE SIMBA

If you use SimBA in your research, please cite:

Goodwin, N. L., Choong, J. J., Hwang, S., et al. (2024). Simple Behavioral Analysis (SimBA) as a platform for explainable machine learning in behavioral neuroscience. Nature Neuroscience, 27, 1411–1424.

@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}
}