https://github.com/bluebrain/psp-validation

Perform spontaneous minis validations

https://github.com/bluebrain/psp-validation

Science Score: 57.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 1 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Academic email domains
  • Institutional organization owner
    Organization bluebrain has institutional domain (portal.bluebrain.epfl.ch)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

Perform spontaneous minis validations

Basic Info
  • Host: GitHub
  • Owner: BlueBrain
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Size: 9.13 MB
Statistics
  • Stars: 0
  • Watchers: 37
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Archived
Created almost 2 years ago · Last pushed about 1 year ago
Metadata Files
Readme Changelog License Authors

README.rst

.. warning::
   The Blue Brain Project concluded in December 2024, so development has ceased under the BlueBrain GitHub organization.
   Future development will take place at: https://github.com/openbraininstitute/psp-validation

psp-validation
================

Validation of Post Synaptic Potentials (PSPs)


Installation
------------

.. code:: bash

    $ pip install psp-validation

Usage
-----

Cli
^^^
The recommended usage is via the command line interface.
To run simulations of psp with the test data:

.. code:: bash

    psp run
        -c tests/input_data/simple/simulation_config.json \
        -t tests/input_data/simple/usecases/hippocampus/targets.yaml \
        -e default \
        tests/input_data/pathway.yaml \
        -o out \
        -n 1 \
        -r 1 \
        -j 1 \
        --dump-traces \
        --dump-amplitudes \
        --seed 400

``-vv`` options stands for verbosity of log output.
There are 3 different values for it:

- ``-v`` is for showing only warnings and errors
- ``-vv`` additionally to ``-v`` shows info messages
- ``-vvv`` additionally shows debug messages.

By default ``-v`` is used.

Somatosensory cortex (SSCx) example
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

After downloading the circuit model from `Zenodo `_ and creating `out` for simulation outputs

edit `usecases/sscx/simulation_config.json` and run:

.. code:: bash

    psp -vv run
        -c usecases/sscx/simulation_config.json
        -t usecases/sscx/targets_v6.yaml
        -e S1nonbarrel_neurons__S1nonbarrel_neurons__chemical
        -o out/
        -n 50
        -r 35
        -j 35 usecases/sscx/pathways/primary/L5_TTPC-L5_TTPC.yaml.yaml
        --dump-traces
        --dump-amplitudes

which will sample 50 pairs of connected L5 thick thufted pyramidal cells from the circuit, trigger a single presynaptic spike from the presynaptic ones

and record the PSP on the postsynaptic ones. The process will be repeated 35 times (as synapses are stochastic and thus PSP varry in amplitude)

on 35 CPUs in parallel. It will saved the postsynaptic traces (to `.h5`), mean PSP amplitudes (to `.txt`) and a summary with a calculated conductance (g_syn)

scaling factor (to `.yaml`).

Testing
^^^^^^^

.. code:: bash

    tox -e py310


Citation
--------

If you use this software, kindly use the following BibTeX entry for citation:

.. code:: bash

    @article{Ecker2020,
    author = {Ecker, Andr{\'{a}}s and Romani, Armando and S{\'{a}}ray, S{\'{a}}ra and K{\'{a}}li, Szabolcs and Migliore, Michele and Falck, Joanne and Lange, Sigrun and Mercer, Audrey and Thomson, Alex M. and Muller, Eilif and Reimann, Michael W. and Ramaswamy, Srikanth},
    doi = {10.1002/hipo.23220},
    journal = {Hippocampus},
    number = {11},
    pages = {1129--1145},
    pmid = {32520422},
    title = {{Data-driven integration of hippocampal CA1 synaptic physiology in silico}},
    volume = {30},
    year = {2020}
    }


Acknowledgements
================

The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

This project/research received funding from the European Union’s Horizon 2020 Framework Programme for Research and Innovation under the Framework Partnership Agreement No. 650003 (HBP FPA).

For license and authors, see LICENSE.txt and AUTHORS.txt respectively.

Copyright (c) 2022-2024 Blue Brain Project/EPFL

Owner

  • Name: The Blue Brain Project
  • Login: BlueBrain
  • Kind: organization
  • Email: bbp.opensource@epfl.ch
  • Location: Geneva, Switzerland

Open Source Software produced and used by the Blue Brain Project

GitHub Events

Total
  • Push event: 1
  • Fork event: 1
Last Year
  • Push event: 1
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: 10 days
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.17
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 17 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • mgeplf (5)
  • joni-herttuainen (3)
  • andrisecker (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 8 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 2
pypi.org: psp-validation

PSP analysis tools

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 8 Last month
Rankings
Dependent packages count: 10.7%
Forks count: 32.6%
Average: 36.5%
Stargazers count: 42.3%
Dependent repos count: 60.5%
Maintainers (2)
Last synced: 6 months ago

Dependencies

.github/workflows/tox.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v4.0.1 composite
pyproject.toml pypi
setup.py pypi
  • attrs >=20.3.0
  • bluecellulab >=2.6.15
  • bluepysnap >=3.0.0,<4.0.0
  • click >=7.0
  • efel >=3.0.39
  • h5py >=3,<4
  • joblib >=0.16
  • matplotlib *
  • numpy >=1.10
  • pandas >=1.3,<2
  • seaborn >=0.11,<1.0
  • tqdm >=4.0
.github/workflows/sdist.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/upload-artifact v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite