Skip to main content

Waveform Editor

The Waveform Editor is a Python tool for creating and managing 1D time-dependent data called waveforms. It utilizes a human-readable, text-based file format where waveforms are described using descriptive tendencies, such as sine waves or linear ramps. The Waveform Editor includes a GUI for interactive creation, editing, and organization of waveforms.

GUI of the Waveform Editor

Development Status

This project is currently under active development. While a functional prototype and core features are already implemented, additional features, usability improvements, and integrations are in progress. The following features are planned for the coming months:

  • UI usability enhancements
  • Integration of Plasma Shape Editor: construct waveforms directly from equilibrium solver output

Install

To install the waveform editor, run the following:

# On SDCC, ensure you have loaded the IMAS-Python module:
# module load IMAS-Python
python -m venv venv
source ./venv/bin/activate
pip install waveform-editor

More detailed instructions for installing can be found on Read the Docs.

Usage

The GUI can be launched using:

waveform-editor gui 

Or the CLI can be launched using:

waveform-editor --help

Docs

The documentation is autogenerated from the source using Sphinx and can be found on Read the Docs.

Alternatively, you can generate the documentation yourself:

pip install .[docs]
make -C docs html

Metadata

Release files for waveform-editor 0.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for waveform-editor 0.3.1
File Size Uploaded Provenance Actions
waveform_editor-0.3.1.tar.gz 1.8 MB With provenance Details for waveform_editor-0.3.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for waveform-editor 0.3.1
File Interpreter ABI Platform Actions
waveform_editor-0.3.1-py3-none-any.whl Python 3 none any Details for waveform_editor-0.3.1-py3-none-any.whl

Total release size: 1.9 MB

Release files / waveform_editor-0.3.1.tar.gz

Download URL waveform_editor-0.3.1.tar.gz
Size 1.8 MB
Tags Source
SHA-256 checksum
How to use checksums
32d445605a7161a0e3c9f75217e77019114d5528b94b5161fd76a8f303ca6631
BLAKE2b-256 checksum
How to use checksums
b5c75a5586e23c32724fc7c3f5dccded1ff01b157ff5f362de7050e687e010a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2025.

Transparency log

Release files / waveform_editor-0.3.1-py3-none-any.whl

Download URL waveform_editor-0.3.1-py3-none-any.whl
Size 103.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
00015b3b7a33a2a5f7292f02534d9090ea2ede7f520f02705a9c5b0b78a0b695
BLAKE2b-256 checksum
How to use checksums
53f6d937632b85440edb581706638d22a8dffa77742dc38a400fed153391ab88
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2025.

Transparency log

Security for waveform-editor 0.3.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for waveform_editor-0.3.1.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2025.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page