optinist

calcium imaging pipeline tool

https://github.com/oist/optinist

Science Score: 49.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 3 DOI reference(s) in README
  • Academic publication links
    Links to: plos.org
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.0%) to scientific vocabulary

Keywords

calcium-imaging neuroscience
Last synced: 7 months ago · JSON representation

Repository

calcium imaging pipeline tool

Basic Info
  • Host: GitHub
  • Owner: oist
  • License: gpl-3.0
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 743 MB
Statistics
  • Stars: 47
  • Watchers: 10
  • Forks: 14
  • Open Issues: 33
  • Releases: 26
Topics
calcium-imaging neuroscience
Created over 4 years ago · Last pushed 7 months ago
Metadata Files
Readme License Codemeta

README.md

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

  • [x] Basic Neural Analysis (Event Trigger Average...)
  • [x] Dimension Reduction (PCA...)
  • [x] Neural Decoding (LDA...)
  • [x] 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 Schrder, 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, Jrmie 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 Rbel, 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.

Owner

  • Name: Okinawa Institute of Science & Technology
  • Login: oist
  • Kind: organization
  • Email: webmaster@oist.jp
  • Location: Okinawa, Japan

CodeMeta (codemeta.json)

{
  "@context": "https://w3id.org/codemeta/3.0",
  "type": "SoftwareSourceCode",
  "applicationCategory": "Neuroscience",
  "author": [
    {
      "id": "_:author_1",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Neural Computation Unit, Okinawa Institute of Science and Technology Graduate University"
      },
      "email": "yukako.yamane@oist.jp",
      "familyName": "Yamane",
      "givenName": "Yukako"
    },
    {
      "id": "_:author_2",
      "type": "Person",
      "familyName": "Li",
      "givenName": "Yuzhe"
    },
    {
      "id": "_:author_3",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Araya Inc."
      },
      "familyName": "Matsumoto",
      "givenName": "Keita"
    },
    {
      "id": "_:author_4",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Araya Inc."
      },
      "familyName": "Kanai",
      "givenName": "Ryota"
    },
    {
      "id": "_:author_5",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Araya Inc."
      },
      "familyName": "Desforges",
      "givenName": "Miles"
    },
    {
      "id": "_:author_6",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Neural Computation Unit, Okinawa Institute of Science and Technology Graduate University"
      },
      "familyName": "Gutierrez",
      "givenName": "Carlos"
    },
    {
      "id": "_:author_7",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Neural Computation Unit, Okinawa Institute of Science and Technology Graduate University"
      },
      "email": "doya@oist.jp",
      "familyName": "Doya",
      "givenName": "Kenji"
    }
  ],
  "codeRepository": "https://github.com/oist/optinist",
  "contributor": [
    {
      "id": "_:contributor_1",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Araya Inc."
      },
      "familyName": "Akiyama",
      "givenName": "Shogo "
    },
    {
      "id": "_:contributor_2",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Araya Inc."
      },
      "familyName": "Hashimoto",
      "givenName": "Rei"
    },
    {
      "id": "_:contributor_3",
      "type": "Person",
      "affiliation": {
        "type": "Organization",
        "name": "Araya Inc."
      },
      "familyName": "Fukuda",
      "givenName": "Yuta"
    }
  ],
  "dateCreated": "2022-02-21",
  "dateModified": "2025-05-26",
  "datePublished": "2022-06-22",
  "description": "OptiNiSt(Optical Neuroimage Studio) is a GUI based workflow pipeline tools for processing 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.",
  "funder": {
    "type": "Organization",
    "name": "AMED"
  },
  "keywords": [
    "Calcium imaging",
    "cell detection",
    "population analysis"
  ],
  "license": "https://spdx.org/licenses/GPL-3.0",
  "name": "OptiNiSt",
  "operatingSystem": [
    "Linux",
    "Windows",
    "MacOS"
  ],
  "programmingLanguage": [
    "Python 3",
    "TypeScript"
  ],
  "runtimePlatform": [
    "Docker",
    "Python 3.9"
  ],
  "version": "2.2.3",
  "developmentStatus": "active",
  "funding": "Brain/MINDS",
  "issueTracker": "https://github.com/oist/optinist/issues",
  "referencePublication": "https://doi.org/10.1371/journal.pcbi.1013087"
}

GitHub Events

Total
  • Fork event: 1
  • Create event: 25
  • Release event: 7
  • Issues event: 27
  • Watch event: 11
  • Delete event: 12
  • Member event: 1
  • Issue comment event: 22
  • Push event: 49
  • Pull request review comment event: 17
  • Gollum event: 31
  • Pull request event: 84
  • Pull request review event: 49
Last Year
  • Fork event: 1
  • Create event: 25
  • Release event: 7
  • Issues event: 27
  • Watch event: 11
  • Delete event: 12
  • Member event: 1
  • Issue comment event: 22
  • Push event: 49
  • Pull request review comment event: 17
  • Gollum event: 31
  • Pull request event: 84
  • Pull request review event: 49

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 124
  • Total pull requests: 207
  • Average time to close issues: 8 months
  • Average time to close pull requests: 11 days
  • Total issue authors: 12
  • Total pull request authors: 13
  • Average comments per issue: 1.68
  • Average comments per pull request: 0.43
  • Merged pull requests: 156
  • Bot issues: 0
  • Bot pull requests: 12
Past Year
  • Issues: 2
  • Pull requests: 77
  • Average time to close issues: N/A
  • Average time to close pull requests: 3 days
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.13
  • Merged pull requests: 62
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • emuemuJP (35)
  • itutu-tienday (27)
  • milesOIST (19)
  • ReiHashimoto (13)
  • Miles-and-miles-away (5)
  • ShogoAkiyama (5)
  • ykyamane (2)
  • DeanTM (2)
  • milesAraya (2)
  • ethanbb (1)
  • kushalkolar (1)
  • ut29 (1)
Pull Request Authors
  • ReiHashimoto (65)
  • tsuchiyama-araya (45)
  • milesAraya (29)
  • itutu-tienday (24)
  • quanpython (16)
  • dependabot[bot] (12)
  • emuemuJP (10)
  • ykyamane (3)
  • sanglevinh (3)
  • josh-oloro (2)
  • kngwyu (2)
  • milesOIST (1)
Top Labels
Issue Labels
enhancement (55) backend (32) bug (30) frontend (29) question (3) documentation (2) dependencies (1) test (1) duplicate (1) testing (1)
Pull Request Labels
dependencies (12) python (10) documentation (7) github_actions (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 238 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 26
  • Total maintainers: 1
pypi.org: optinist

Calcium Imaging Pipeline Tool

  • Versions: 26
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 238 Last month
Rankings
Dependent packages count: 6.6%
Forks count: 13.6%
Stargazers count: 14.2%
Average: 20.6%
Dependent repos count: 30.6%
Downloads: 38.1%
Maintainers (1)
Last synced: 7 months ago

Dependencies

docs/requirements.txt pypi
  • myst-parser *
  • sphinx >=4.3.0,<4.6.0
  • sphinx-autobuild ==2021.3.14
  • sphinx-autodoc-typehints *
  • sphinx-copybutton ==0.5.0
  • sphinx-prompt *
  • sphinx_rtd_theme *
  • sphinxcontrib-apidoc *
docker-compose.yml docker
  • build_optinist_frontend latest
  • test_optinist latest
  • test_optinist_frontend latest
.github/workflows/linters.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • liskin/gh-problem-matcher-wrap a89a18291dcde8d4e6158adf736b5432987bbf95 composite
  • psf/black stable composite
docker-compose.dev.yml docker
  • node 16.20.1-alpine
docker-compose.test.yml docker
  • build_studio_frontend latest
  • test_studio latest
  • test_studio_frontend latest
frontend/package.json npm
  • @types/plotly.js ^1.54.16 development
  • @types/react-redux ^7.1.25 development
  • lint-staged ^11.1.2 development
  • prettier ^2.3.2 development
  • @emotion/react ^11.7.1
  • @emotion/styled ^11.6.0
  • @mui/icons-material ^5.4.1
  • @mui/lab ^5.0.0-alpha.68
  • @mui/material ^5.4.1
  • @mui/x-data-grid ^6.11.1
  • @reduxjs/toolkit ^1.6.1
  • @testing-library/jest-dom ^5.11.4
  • @testing-library/react ^11.1.0
  • @testing-library/user-event ^12.1.10
  • @types/colormap ^2.3.1
  • @types/jest ^26.0.15
  • @types/node ^16.0.0
  • @types/qs ^6.9.7
  • @types/react ^17.0.19
  • @types/react-color ^3.0.6
  • @types/react-dom ^17.0.0
  • axios ^0.21.1
  • colormap ^2.3.2
  • flexlayout-react ^0.5.12
  • moment ^2.29.4
  • notistack ^2.0.3
  • plotly.js ^2.6.0
  • qs ^6.11.2
  • react ^17.0.2
  • react-color ^2.19.3
  • react-dnd ^16.0.1
  • react-dnd-html5-backend ^16.0.1
  • react-dom ^17.0.2
  • react-flow-renderer ^10.3.17
  • react-linear-gradient-picker ^2.0.2
  • react-plotlyjs-ts ^2.2.2
  • react-redux ^7.2.9
  • react-router-dom ^6.6.2
  • react-scripts 4.0.3
  • styled-components ^5.3.0
  • typescript ^4.1.2
  • web-vitals ^1.0.1
frontend/yarn.lock npm
  • 1863 dependencies
pyproject.toml pypi
  • aiofiles *
  • alembic ==1.9.2
  • fastapi ==0.99.*
  • fastapi_pagination ==0.12.5
  • filelock *
  • firebase_admin *
  • future *
  • httpx *
  • imageio *
  • jinja2 ==3.1.*
  • kaleido ==0.2.1
  • nbstripout *
  • numpy >=1.23,<1.26
  • plotly ==5.15.0
  • psutil *
  • pydantic [dotenv]
  • pydantic [email]
  • pymysql ==1.0.2
  • pynwb ==2.2.0
  • pyrebase4 ==4.7.1
  • python-jose [cryptography]
  • python-multipart *
  • pyyaml *
  • snakemake >=7.24,<7.31
  • sqlmodel ==0.0.8
  • tifffile *
  • tqdm *
  • uvicorn ==0.22.*
.github/workflows/codespell.yml actions
  • actions/checkout v4 composite
  • codespell-project/actions-codespell v2 composite
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
poetry.lock pypi
  • 184 dependencies
docker-compose.build.yml docker
  • node 20.8.0-alpine3.18
docker-compose.dev.multiuser.yml docker
  • mysql 8.4
  • node 20.8.0-alpine3.18
studio/config/docker/Dockerfile docker
  • python 3.9-slim build