Signal Edges

Signal Edges is a Python package capable of filtering, extracting state levels and edges of signals with millions of samples, among other things. It is specially suited for analysis of analog signals obtained through recorders, such as oscilloscopes or data recorders, and hardware automation in CI/CD environments, although it is flexible enough to be used for many other different purposes.

Find Signal Edges on PyPi, or install it as follows:

pip install python-signal-edges

Refer to the documentation here for more details.

Development

Clone the repository as:

git clone https://github.com/dmg0345/python-signal-edges

Ensure the Github file with the relevant environment variables exist as expected in the compose.yaml file and the correct paths are set in the manage.ps1 file for your environment. Afterwards, find the base Docker image for the development container at DockerHub.

To develop using devcontainers and Visual Studio Code:

docker pull dmg00345/python_signal_edges:latest
./manage.ps1 run

Create a release

To generate a release follow the steps below:

1. Create a release branch from develop branch, e.g. release/X.Y.Z.
2. Update version in conf.py file and in pyproject.toml file.
3. Create pull request from release branch to master with the changes with title Release X.Y.Z.
4. When merged in master create release and tag from Github, review production workflow passes for deployment.
5. Delete the release/X.Y.Z branch.