Metadata-Version: 2.4
Name: neuro_mine
Version: 0.9.0
Summary: Identifies the contribution of behavioural and stimulus parameters to neural activity
Author-email: Danica Matovic <matovic.5@osu.edu>, Martin Haesemeyer <haesemeyer.1@osu.edu>
Project-URL: Homepage, https://github.com/matovic5/neuro_mine
Description-Content-Type: text/markdown
Requires-Dist: h5py==3.14.*
Requires-Dist: matplotlib==3.9.*
Requires-Dist: numba==0.60.*
Requires-Dist: numpy==1.26.*
Requires-Dist: pandas==2.3.*
Requires-Dist: PySide6==6.7.*
Requires-Dist: scipy==1.13.*
Requires-Dist: tensorflow<=2.15.1
Requires-Dist: upsetplot==0.9.*
Requires-Dist: scikit-learn==1.6.*
Requires-Dist: urllib3==1.26.*
Requires-Dist: psutil==7.2.*
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"

# Neuro-MINE (Model Identification of Neural Encoding) 🧠💻

Welcome to Neuro-MINE: your handy companion for processing neuronal response data!

This app allows users to use MINE as a GUI or in the command line to train a flexible,
convolutional neural network (CNN) to analyze experimental datasets containing neural
activity and corresponding predictors (e.g., behavioral responses).

Neuro-MINE makes an updated version of MINE ([Costabile et al., 2023](https://elifesciences.org/articles/83289))
available in an easy-to-use interface.
This version of MINE now supports spiking data as well as episodic data.
For episodic data, care is taken that model fits, Taylor decomposition, and prediction correctly
handle episode boundaries.
Furthermore, Neuro-MINE provides easily interpretable outputs in a model insights file that can be used as
starting points for further analysis.

# How to use
*Read The Docs:* https://neuro-mine.readthedocs.io

# Acknowledgements
*Authors:*
<br>Danica Matovic
<br>Martin Haesemeyer
<br>Jamie Costabile
<br>Kaarthik Balakrishnan
<br>Sina Schwinn

*Publication:* Costabile JD, Balakrishnan KA, Schwinn S, Haesemeyer M. Model discovery to link neural activity to behavioral tasks. Elife. 2023 Jun 6;12:e83289. doi: 10.7554/eLife.83289. PMID: 37278516; PMCID: PMC10310322. https://elifesciences.org/articles/83289

*GitHub Repository of Original Publication:* https://github.com/haesemeyer/mine_pub
<br>*Lab Website:* https://www.thermofish.org/

All code is licensed under the MIT license. See LICENSE for details.
<br>© Martin Haesemeyer, Jamie D Costabile, Kaarthik A Balakrishnan, and Danica Matovic 2020-2025
<br> Questions may be directed to haesemeyer.1@osu.edu
