SimBA
Note
These docs are under active development. For detailed tutorials, code, and more extensive documentation, see the SimBA GitHub repository.
🚀 INSTALLATION
To install SimBA from PyPI, run the following (use Python 3.6, or 3.10 if necessary):
pip install simba-uw-tf-dev
Then launch it by typing simba. For step-by-step setup — conda, Anaconda Navigator, or
video walkthroughs — see the full installation guide:
📑 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.
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}
}
MORE INFORMATION
Everything in one place — code, API, community, publications, and data:
API REFERENCE:
- 📖 API Reference
- 🔍 Blob tracking tools
- 📦 Bounding-box tools
- 🔁 Circular transformations
- 🔧 Config reader
- 💡 Cue-light tools
- 🔧 Data processing tools
- 📏 Feature extraction mixins
- 📝 Feature extraction wrappers
- 📐 Geometry transformations
- 🖼️ Image transformations
- 🏷️ Labeling tools
- 🤖 Model tools
- 🔗 Network transformations
- ⚠️ Outlier correction
- 🎨 Plotting and visualization tools
- 📦 Pose-estimation import tools
- 🗺️ ROI tools
- 📊 Statistics transformations
- 📥 Third-party label appenders
- 🕐 Time-series transformations
- 🔮 Unsupervised learning
- 🖥️ User Interface (UI) tools
- ⚙️ Utilities
- 📹 Video processing tools
- 👁️ YOLO Methods
NOTEBOOKS:
- 📚 Notebooks
- ⚙️ General processing
- Import data and perform classifications (Example 1)
- Shapley calculations: Example I (single core)
- Shapley calculations: Example II (multiple cores)
- Shapley calculations: Example III (GPU)
- Outlier correction
- Append third-party annotations
- Advanced smoothing and interpolation
- Advanced outlier correction
- Kleinberg batch / grid-search
- Train models: Example 1
- 📊 Visualizations
- 📐 Geometry- and image-related calculators
- Geometry computations Example 1: Movement key-point statistics in grid-system
- Geometry computations Example 2: Movement hull statistics in grid-system
- Geometry computations Example 3: Animal paths
- Geometry computations Example 4: Slice animal videos on CPU
- Geometry computations Example 5: Slice animal shapes
- Geometry computations Example 6: ROI and path statistics
- Geometry computations: Example 7
- YOLO bounding boxes: Example 1
- Remove video background
- Egocentric data and video alignment
- Blob tracking with SimBA
- 📹 Blob tracking visualization
- 🧰 Miscellaneous
- ⚙️ General processing
USER GUIDE / TUTORIALS:
WALKTHROUGHS:
LABELLING TUTORIALS:
GALLERY: