Skip to main content

pre-commit.ci status

OSS-DBSv2

This is the development version of the OSS-DBS rewrite. Use with caution and please wait for the first official release before deploying it. Bug reports are highly welcome, though!

Installation

OSS-DBS is tested with Python 3.10, 3.11, 3.12, and 3.13.

Windows users: Please install NEURON separately before installing OSS-DBS. The instructions can be found here.

All other users can run

pip install ossdbs

Developers

We recommend uv for development. It is a fast, drop-in replacement for pip/virtualenv that manages the virtual environment and Python interpreter for you and uses the checked-in uv.lock for fully reproducible installs. See the installation instructions.

Clone OSS-DBS into a local directory, cd into it, and create the environment with the exact locked dependencies:

uv sync

uv sync creates a .venv/ and installs OSS-DBS in editable mode. Select optional dependency groups with --extra:

uv sync --extra test    # to run the test suite
uv sync --extra dev     # to develop OSS-DBS
uv sync --extra doc     # to locally build the docs
uv sync --extra all     # everything of the above

Run commands inside the environment with uv run, e.g. uv run pytest or uv run ossdbs input.json (no manual activation needed).

Prefer plain pip? Click to expand.

Everything above also works with pip. Clone OSS-DBS, cd into the directory and run one of:

pip install -e .            # base install
pip install -e ".[test]"    # to run the test suite
pip install -e ".[dev]"     # to develop OSS-DBS
pip install -e ".[doc]"     # to locally build the docs
pip install -e ".[all]"     # everything of the above

Note that pip resolves dependencies fresh and does not use uv.lock.

Run OSS-DBS

To run OSS-DBS, cd into the input_files directory, insert your parameters in the input.json and start the simulation with

ossdbs input.json

Also check out the examples directory and the documentation.

Development

The code development follows different coding styles that are checked by git pre-commit hooks. After uv sync --extra dev (or pip install -e ".[dev]"), activate the hooks with uv run pre-commit install (or pre-commit install).

Testing

OSS-DBS has two types of tests:

Unit Tests (tests/): Fast, isolated tests that run on every push/PR.

pytest                    # Run all unit tests
pytest --cov              # With coverage

Simulation Tests (input_test_cases/): Full simulation tests that validate the complete pipeline. These run only on pull requests to avoid slowing down regular development.

pytest input_test_cases/test_simulations.py -m simulation      # All simulation tests
pytest input_test_cases/test_simulations.py -m "simulation and not slow"  # Fast only

See input_test_cases/README.md for detailed documentation on the simulation test suite, including how to add new tests.

Directory Structure

  • tests/ - Unit tests (run on every commit)
  • input_test_cases/ - Simulation tests (run on PR only)
  • input_files/ - Reference input files
  • examples/ - Example code for users (may be resource-intensive)

Standalone executables

build_merged.py freezes OSS-DBS and all of its dependencies into a self-contained bundle with PyInstaller, so that end users do not need a Python toolchain. On Windows this is also how NEURON is shipped: install and compile NEURON into the build environment first, then freeze it into the bundle so users get PAM support without installing NEURON themselves.

PyInstaller freezes whatever is present in the current environment, so provision that environment reproducibly with uv and the checked-in uv.lock before building:

uv sync --locked --group bundle   # locked deps + PyInstaller, from uv.lock
# (Windows only) install + compile NEURON into .venv here, see
# docs/windows_neuron_setup.md
uv run python build_merged.py

PyInstaller lives in the bundle dependency group, so it is pinned in uv.lock and installed from there rather than pulled from an external pip.

The bundle is written to dist/ossdbs_bundle/. Because the environment comes from uv.lock, the frozen dependency set is identical across rebuilds; run uv lock (and commit the result) whenever you intentionally update a dependency.

Metadata

Release files for ossdbs 0.5.9

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ossdbs 0.5.9
File Size Uploaded Provenance Actions
ossdbs-0.5.9.tar.gz 311.0 kB With provenance Details for ossdbs-0.5.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ossdbs 0.5.9
File Interpreter ABI Platform Actions
ossdbs-0.5.9-py3-none-any.whl Python 3 none any Details for ossdbs-0.5.9-py3-none-any.whl

Total release size: 539.0 kB

Release files / ossdbs-0.5.9.tar.gz

Download URL ossdbs-0.5.9.tar.gz
Size 311.0 kB
Tags Source
SHA-256 checksum
How to use checksums
302ba05c7de9f16462a1f10b087b6375837f4c1e417f6895f9da25446e33cf79
BLAKE2b-256 checksum
How to use checksums
45a62e97580bc4f131c16174a8494ecba1f6287c43ef35fced25050ffbd8a1c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / ossdbs-0.5.9-py3-none-any.whl

Download URL ossdbs-0.5.9-py3-none-any.whl
Size 227.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a61431ca006f5fc710735f74156f6aed3ae52e643f56a9c2871d4f1c65881bab
BLAKE2b-256 checksum
How to use checksums
d5529c32e3f1358b6dd0a491611081a84e7a238fc10ef746119bd54529daa00b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for ossdbs 0.5.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ossdbs-0.5.9.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.9 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page