Software for collecting, storing and accessing Scope Mode RF Waveforms. This projects relies on python v3.11+.
More complete documentation can be found at GitHub Pages.
Starting with version 0.2.0, source and wheel files are attached to each GitHub release and can be installed using pip as follows. Update the version strings to match desired version. See Releases for more details.
pip install https://github.com/JeffersonLab/rfscopedb/releases/download/v0.2.0/rfscopedb-0.2.0-py3-none-any.whl
Below is an example of querying data from rfscopedb database. This assumes you have a production database running or that you have the provided docker container database running (see Developer Quick Start Guide).
from rfscopedb.db import WaveformDB
from rfscopedb.data_model import Query
db = WaveformDB(host='localhost', user='scope_rw', password='password')
q = Query(db=db, signal_names=["GMES", "PMES"])
# queries information on the scans that meet the criteria in q. This should be quick.
q.stage()
# queries the waveform data related to the scans found by stage(). This may take longer as each scan can have many
# waveforms, and each waveform is 8,192 samples long.
q.run()
print(q.wf_data.head())Download the repo, create a virtual environment using pythong 3.11+, and install the package in editable mode with development dependencies. Then develop using your preferred IDE, etc.
Linux
git clone https://github.com/JeffersonLab/rfscopedb
cd rfscopedb
python3.11 -m venv venv
venv/bin/activate
pip install -e .[dev]Windows
git clone https://github.com/JeffersonLab/rfscopedb
cd rfscopedb
\path\to\python3 -m venv venv
venv\Scripts\activate.ps1
pip install -e .[dev]To start the provided database.
docker compose up
This application supports testing using pytest and code coverage using coverage. Configuration in pyproject.toml.
Integration tests required that the provided docker container(s) are running. Tests are automatically run on appropriate triggers.
| Test Type | Command |
|---|---|
| Unit | pytest test/unit |
| Integration | pytest test/integration |
| Unit & Integration | pytest |
| Code Coverage | coverage run |
| Linting | pylint src/ test/unit test/integration |
Documentation is done in Sphinx and automatically built and published to GitHub Pages when triggering a new release. To build documentation, run this commands from the project root.
sphinx-build -b html docsrc/source build/docs