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.
.. figure:: https://github.com/dmg0345/python-signal-edges/blob/master/doc/.assets/img/007_example_complex_plot_1.png
:align: center
Find **Signal Edges** on `PyPi <https://pypi.org/project/python-signal-edges/>`_, or install it as follows:
.. code-block::
pip install python-signal-edges
Refer to the documentation `here <https://dmg0345-python-signal-edges.netlify.app/>`_ for more details.
Development
------------------------------------------------------------------------------------------------------------------------
Clone the repository as:
.. code-block:: powershell
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 <https://hub.docker.com/r/dmg00345/python_signal_edges>`_.
To develop using `devcontainers` and `Visual Studio Code`:
.. code-block:: powershell
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/dmg0345/python-signal-edges",
"name": "python-signal-edges",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "python, signal, edges, automation, hardware, pwm, acquisition",
"author": "Diego Martinez",
"author_email": "dmg0345@gmail.com",
"download_url": null,
"platform": null,
"description": "Signal Edges\n------------------------------------------------------------------------------------------------------------------------\n\n**Signal Edges** is a Python package capable of filtering, extracting state levels and edges of signals with millions\nof samples, among other things. It is specially suited for analysis of analog signals obtained through recorders, such\nas oscilloscopes or data recorders, and hardware automation in CI/CD environments, although it is flexible enough to\nbe used for many other different purposes.\n\n.. figure:: https://github.com/dmg0345/python-signal-edges/blob/master/doc/.assets/img/007_example_complex_plot_1.png\n :align: center\n\nFind **Signal Edges** on `PyPi <https://pypi.org/project/python-signal-edges/>`_, or install it as follows:\n\n.. code-block::\n\n pip install python-signal-edges\n\nRefer to the documentation `here <https://dmg0345-python-signal-edges.netlify.app/>`_ for more details.\n\nDevelopment\n------------------------------------------------------------------------------------------------------------------------\n\nClone the repository as:\n\n.. code-block:: powershell\n\n git clone https://github.com/dmg0345/python-signal-edges\n\nEnsure the *Github* file with the relevant environment variables exist as expected in the *compose.yaml* file and the\ncorrect paths are set in the *manage.ps1* file for your environment. Afterwards, find the base Docker image for the\ndevelopment container at `DockerHub <https://hub.docker.com/r/dmg00345/python_signal_edges>`_.\n\nTo develop using `devcontainers` and `Visual Studio Code`:\n\n.. code-block:: powershell\n\n docker pull dmg00345/python_signal_edges:latest\n ./manage.ps1 run\n\nCreate a release\n------------------------------------------------------------------------------------------------------------------------\n\nTo generate a release follow the steps below:\n\n1. Create a ``release`` branch from ``develop`` branch, e.g. ``release/X.Y.Z``.\n2. Update version in *conf.py* file and in *pyproject.toml* file.\n3. Create pull request from ``release`` branch to ``master`` with the changes with title *Release X.Y.Z*.\n4. When merged in ``master`` create release and tag from *Github*, review production workflow passes for deployment.\n5. Delete the ``release/X.Y.Z`` branch.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Extract state levels and edges from signals, among others",
"version": "1.0.5",
"project_urls": {
"Documentation": "https://dmg0345-python-signal-edges.netlify.app/",
"Homepage": "https://github.com/dmg0345/python-signal-edges",
"Repository": "https://github.com/dmg0345/python-signal-edges"
},
"split_keywords": [
"python",
" signal",
" edges",
" automation",
" hardware",
" pwm",
" acquisition"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c1733bc9533d726b35722b76bdbbe3b6d785816196e7ce43be1190978727b4c1",
"md5": "0324a614aafd0996f12d7b37d12d94ef",
"sha256": "282b555f9704c9b1d908b4d9f95c66b02fe93667cf2a67320c0448d193dfcbd4"
},
"downloads": -1,
"filename": "python_signal_edges-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0324a614aafd0996f12d7b37d12d94ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 46095,
"upload_time": "2024-04-21T11:19:52",
"upload_time_iso_8601": "2024-04-21T11:19:52.176306Z",
"url": "https://files.pythonhosted.org/packages/c1/73/3bc9533d726b35722b76bdbbe3b6d785816196e7ce43be1190978727b4c1/python_signal_edges-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-21 11:19:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dmg0345",
"github_project": "python-signal-edges",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-signal-edges"
}
JSON
