Installation

OSS-DBS can now be easily installed using pip. The software runs with Python versions 3.10, 3.11, 3.12, and 3.13.

Basic Installation

For most users, simply run the following command:

$ pip install ossdbs

On Windows, the NEURON simulator must be installed separately before installing OSS-DBSv2. Installation instructions for NEURON are available at the NEURON installation guide.

Developer Installation

To install OSS-DBSv2 from source for development:

$ git clone https://github.com/SFB-ELAINE/OSS-DBSv2.git
$ cd OSS-DBSv2
$ pip install -e .

Additional Installation Options

Install OSS-DBSv2 together with the test suite:
```
$ pip install -e ".[test]"
```
Install OSS-DBSv2 with development dependencies:
```
$ pip install -e ".[dev]"
```
Install OSS-DBSv2 with all optional dependencies:
```
$ pip install -e ".[all]"
```

Checking the installation

After installation, a simple first check is to run one of the shipped example input files as described in Tutorial.

Next Steps

For first steps with OSS-DBSv2, see Tutorial. Example simulations can be found in Examples.