Welcome to STG4000’s documentation!¶
This documentation explains the python package wrapping the C# .dll offered by multichannelsystems to control their STG4000 range of electrical stimulators.
Installation¶
git clone https://github.com/pyreiz/app-stg4000
cd app-stg4000
pip install -r requirements.txt
pip install -e .
#download and install the dll from mulitchannelsystems
python -m stg.install
Because of this, the pacakage only works on Windows. If the package is run on Linux, skip the installation of the requirements. On linux, the package automatically mocks the interface to the STG4000. This allows to run tests and build documentation, and can help when you write scripts for your experiments.
Testing¶
Connect your oscilloscope and start the following example:
from stg.api import PulseFile, STG4000
stg = STG4000()
stg.download(0, *PulseFile().compile())
stg.start_stimulation([0])
You can run full tests using pytest, mypy or everything with :code: make test from the root of the package. By default, downloading the dll is not tested, but can be turned on with pytest -m "install".