Skip to main content

Calcium Imaging Pipeline Tool

Project description

OptiNiSt optinist

PYPI PYPI

OptiNiSt(Optical Neuroimage Studio) is a GUI based workflow pipeline tools for processing two-photon calcium imaging data.

OptiNiSt helps researchers try multiple data analysis methods, visualize the results, and construct the data analysis pipelines easily and quickly on GUI. OptiNiSt's data-saving format follows NWB standards.

OptiNiSt also supports reproducibility of scientific research, standardization of analysis protocols, and developments of novel analysis tools as plug-in.

Support Library

ROI detection

Postprocessing

  • Basic Neural Analysis (Event Trigger Average...)
  • Dimension Reduction (PCA...)
  • Neural Decoding (LDA...)
  • Neural Population Analysis (Correlation...)

Saving Format

Key Features

:beginner: Easy-To-Create Workflow

  • zero-knowledge of coding: OptiNiSt allows you to create analysis pipelines easily on the GUI.

:zap: Visualizing analysis results

  • quick visualization: OptiNiSt supports you visualize the analysis results by plotly.

:rocket: Managing Workflows

  • recording and reproducing: OptiNiSt records and reproduces the workflow pipelines easily.

Installation

Need anaconda or miniconda or miniforge environment.

conda create -n optinist python=3.9
conda activate optinist

Install from pip.

pip install optinist

launch.

run_optinist

Open browser. http://localhost:8000

Documentation

https://optinist.readthedocs.io/en/latest/

Using GUI

Workflow

  • OptiNiSt allows you to make your analysis pipelines by graph style using nodes and edges on GUI. Parameters for each analysis are easily changeable.

workflow

Visualize

  • OptiNiSt allows you to visualize the analysis results with one click by plotly. It supports a variety of plotting styles.

visualize

Record

  • OptiNiSt supports you in recording and reproducing workflow pipelines in an organized manner.

record

Contributors

Proposers

Kenji Doya, Yukako Yamane OIST Neural Computation Unit

Main Developers

Shogo Akiyama, Yoshifumi Takeshima

Support Developers

Tatsuya Tanabe, Yosuke Kaneko, Syuya Saeki

References

[Suite2p] Marius Pachitariu, Carsen Stringer, Mario Dipoppa, Sylvia Schröder, L. Federico Rossi, Henry Dalgleish, Matteo Carandini, Kenneth D. Harris. "Suite2p: beyond 10,000 neurons with standard two-photon microscopy". 2017 [CaImAn] Andrea Giovannucci Is a corresponding author, Johannes Friedrich, Pat Gunn, Jérémie Kalfon, Brandon L Brown, Sue Ann Koay, Jiannis Taxidis, Farzaneh Najafi, Jeffrey L Gauthier, Pengcheng Zhou, Baljit S Khakh, David W Tank, Dmitri B Chklovskii, Eftychios A Pnevmatikakis. "CaImAn: An open source tool for scalable Calcium Imaging data Analysis". 2019 [LCCD] Tsubasa Ito, Keisuke Ota, Kanako Ueno, Yasuhiro Oisi, Chie Matsubara, Kenta Kobayashi, Masamichi Ohkura, Junichi Nakai, Masanori Murayama, Toru Aonishi, "Low computational-cost cell detection method for calcium imaging data", 2022 [PyNWB] Oliver Rübel, Andrew Tritt, Ryan Ly, Benjamin K. Dichter, Satrajit Ghosh, Lawrence Niu, Ivan Soltesz, Karel Svoboda, Loren Frank, Kristofer E. Bouchard, "The Neurodata Without Borders ecosystem for neurophysiological data science", bioRxiv 2021.03.13.435173, March 15, 2021

Citation

If you use this software, please cite our paper: https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1013087 Read our paper
@misc{OptiNiSt,
	author = {Yamane, Yukako and Li, Yuzhe and Matsumoto, Keita and Kanai, Ryota and Desforges, Miles and Gutierrez, Carlos Enrique and Doya, Kenji},
	title = {Optical Neuroimage Studio (OptiNiSt): intuitive, scalable, extendable framework for optical neuroimage data analysis},
	volume = {21},
	issue = {5},
	year = {2025},
	doi = {10.1371/journal.pcbi.1013087},
  journal = {PLOS Computational Biology}
}

Join Our User Community on Slack

We've launched a Slack workspace to provide a more casual space for discussions and interaction among users.

Join the Optinist User Community on Slack

Feel free to use it as a space for casual conversations, product questions, requests, and feedback.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

optinist-2.2.3.tar.gz (79.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

optinist-2.2.3-py3-none-any.whl (79.7 MB view details)

Uploaded Python 3

File details

Details for the file optinist-2.2.3.tar.gz.

File metadata

  • Download URL: optinist-2.2.3.tar.gz
  • Upload date:
  • Size: 79.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.9.23 Darwin/23.6.0

File hashes

Hashes for optinist-2.2.3.tar.gz
Algorithm Hash digest
SHA256 2cd50bfeea9d1f62068a4a40818895a10c1bea13d2a179916f4f8afa797faeaa
MD5 e557cbbe28035923831e6a5e9aff87e4
BLAKE2b-256 f5be734bd8af1943f8d541c8570ee0cb582ed7f84d59db12c739909e32f2c7c9

See more details on using hashes here.

File details

Details for the file optinist-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: optinist-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 79.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.9.23 Darwin/23.6.0

File hashes

Hashes for optinist-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 10d7c9f3a6106e9a322b286bfaaeb7daa321d4e81caa02eccec14c471dc5f142
MD5 12f9004ad8b2049c91d2e868486d11da
BLAKE2b-256 850ffda23ab503d15d6e667a6dfcff88c74539bd68ded1a2c6755fac248e270e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page