improv

Adaptive Platform for Neuroscience Experiments

https://github.com/project-improv/improv

Science Score: 36.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
  • Academic publication links
  • Committers with academic emails
    8 of 22 committers (36.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.5%) to scientific vocabulary

Keywords from Contributors

transformation
Last synced: 10 months ago · JSON representation

Repository

Adaptive Platform for Neuroscience Experiments

Basic Info
Statistics
  • Stars: 40
  • Watchers: 4
  • Forks: 13
  • Open Issues: 20
  • Releases: 6
Created almost 8 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

Adaptive experiments for neuroscience

PyPI PyPI - Python Version docs tests Coverage Status PyPI - License Code style: black

improv is a streaming software platform designed to enable adaptive experiments. By analyzing data as they arrive, we can obtain information about the current brain state in real time and use it to adaptively modify an experiment as data collection is ongoing.

This video shows raw 2-photon calcium imaging data in zebrafish, with cells detected in real time by CaImAn, and directional tuning curves (shown as colored neurons) and functional connectivity (lines) estimated online, during a live experiment. Here only a few minutes of data have been acquired, and neurons are colored by their strongest response to visual simuli shown so far. We also provide up-to-the-moment estimates of the functional connectivity by fitting linear-nonlinear-Poisson models online, as each new piece of data is acquired. Simple visualizations offer real-time insights, allowing for adaptive experiments that change in response to the current state of the brain.

How improv works

improv allows users to flexibly specify and manage adaptive experiments to integrate data collection, preprocessing, visualization, and user-defined analytics. All kinds of behavioral, neural, or modeling data can be incorporated, and input and output data streams are managed independently and asynchronously. With this design, streaming analyses and real-time interventions can be easily integrated into various experimental setups. improv manages the backend engineering of data flow and task execution for all steps in an experimental pipeline in real time, without requiring user oversight. Users need only define their particular processing pipeline with simple text files and are free to define their own streaming analyses via Python classes, allowing for rapid prototyping of adaptive experiments.


improv's design is based on a streamlined version of the actor model for concurrent computation. Each component of the system (experimental pipeline) is considered an 'actor' and has a unique role. They interact via message passing, without the need for a central broker. Actors are implemented as user-defined classes that inherit from improv's Actor class, which supplies all queues for message passing and orchestrates process execution and error handling. Messages between actors are composed of keys that correspond to items in a shared, in-memory data store. This both minimizes communication overhead and data copying between processes.

Installation

For installation instructions, please consult the documentation.

Contact

To get in touch, feel free to reach out on Twitter @annedraelos or @jmxpearson.

Owner

  • Name: project-improv
  • Login: project-improv
  • Kind: organization

GitHub Events

Total
  • Issues event: 3
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 10
  • Push event: 26
  • Pull request review event: 22
  • Pull request review comment event: 57
  • Pull request event: 4
  • Fork event: 2
  • Create event: 4
Last Year
  • Issues event: 3
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 10
  • Push event: 26
  • Pull request review event: 22
  • Pull request review comment event: 57
  • Pull request event: 4
  • Fork event: 2
  • Create event: 4

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 887
  • Total Committers: 22
  • Avg Commits per committer: 40.318
  • Development Distribution Score (DDS): 0.822
Past Year
  • Commits: 49
  • Committers: 9
  • Avg Commits per committer: 5.444
  • Development Distribution Score (DDS): 0.51
Top Committers
Name Email Commits
Anne Draelos h****s 158
saraliszeski 7****i 146
cyzhou1028 c****u@d****u 132
draelos 96
Chaichontat Sriworarat c****s@d****u 77
eaogorman e****1@d****u 56
eaogorman e****n@g****m 48
Daniel Sprague d****9@d****u 48
John Pearson j****n@g****m 24
NICOLE MOISEYEV n****0@g****m 24
Annie Do v****o@d****u 24
Anne Draelos 4****s 18
RaymondChenDuke r****4@d****u 10
Tony 4****a 10
Sara Liszeski s****i@d****u 4
Shiyang Pan 5****l 3
Chang Li 9****i 2
eaogorman e****3@g****m 2
dobaongocvi v****9@d****u 2
chaichontat 3****t 1
Kushal Kolar k****r@g****m 1
Daniel Sprague 4****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 63
  • Total pull requests: 128
  • Average time to close issues: 8 months
  • Average time to close pull requests: 2 months
  • Total issue authors: 11
  • Total pull request authors: 20
  • Average comments per issue: 1.16
  • Average comments per pull request: 1.25
  • Merged pull requests: 89
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 5
  • Pull requests: 11
  • Average time to close issues: 21 days
  • Average time to close pull requests: about 7 hours
  • Issue authors: 4
  • Pull request authors: 6
  • Average comments per issue: 0.6
  • Average comments per pull request: 0.91
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 1
Top Authors
Issue Authors
  • jmxpearson (27)
  • draelos (16)
  • kushalkolar (5)
  • rwschonberg (4)
  • clewis7 (2)
  • eaogorman (2)
  • Tonynanra (1)
  • chaichontat (1)
  • cyzhou1028 (1)
  • raymondhechen (1)
  • WaAaaAterfall (1)
Pull Request Authors
  • jmxpearson (31)
  • draelos (29)
  • rwschonberg (19)
  • chaichontat (12)
  • dysprague (9)
  • cyzhou1028 (7)
  • WaAaaAterfall (6)
  • eaogorman (5)
  • saraliszeski (4)
  • myniax1024 (3)
  • clewis7 (3)
  • kushalkolar (3)
  • dependabot[bot] (3)
  • ameliacang7 (3)
  • MarleneLi (3)
Top Labels
Issue Labels
enhancement (4) wontfix (1)
Pull Request Labels
dependencies (3) github_actions (2)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 31 last-month
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 4
    (may contain duplicates)
  • Total versions: 7
  • Total maintainers: 2
proxy.golang.org: github.com/project-improv/improv
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.9%
Last synced: 11 months ago
pypi.org: improv

Platform for adaptive neuroscience experiments

  • Documentation: https://improv.readthedocs.io/
  • License: MIT License Copyright (c) 2019 Pearson Lab at Duke University Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  • Latest release: 0.2.2
    published over 2 years ago
  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 4
  • Downloads: 31 Last month
Rankings
Dependent repos count: 7.5%
Dependent packages count: 10.0%
Forks count: 11.4%
Stargazers count: 11.7%
Average: 17.7%
Downloads: 47.8%
Maintainers (2)
Last synced: 10 months ago

Dependencies

.github/workflows/CI.yaml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • coverallsapp/github-action v2 composite
  • psf/black stable composite
.github/workflows/deploy.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
  • peaceiris/actions-gh-pages v3.6.1 composite
docs/requirements.txt pypi
  • jupyter-book *
  • matplotlib *
  • numpy *
pyproject.toml pypi
  • PyQt5 *
  • h5py *
  • lmdb *
  • matplotlib *
  • numpy *
  • psutil *
  • pyarrow ==9.0.0
  • pyyaml *
  • pyzmq *
  • scipy *
  • textual ==0.15.0