Skip to main content

Wal - Wavefile Analysis Language

Project description

WAL the Waveform Analysis Language

Test and Build

The Waveform Analysis language logo

Welcome to the Waveform Analysis Language (WAL) repository. This domain-specific language aims at enabling automated and sophisticated analysis of hardware waveforms. In WAL, hardware-specific things such as signals and simulation time are treated as first-class citizens of the language.

Installation from PyPi

WAL is available from PyPi!

pip install wal-lang --user

On some systems, pip does not add WALs installation path to the PATH variable. If the "wal" command is not available after installation please add the installation path, e.g. ~/.local/bin on Ubuntu, to your PATH variable.

To get the latest development version of WAL you can clone this repository. After that, follow the instructions for your OS below inside the cloned directory.

Installation from Source

For Ubuntu (22.04 LTS):

sudo apt install git cmake python3-cffi python3.10-venv python3-pip build-essential -y
git clone https://github.com/ics-jku/wal.git
cd wal
PYTHON=python3 make install
echo "export PATH=\$PATH:$HOME/.local/bin" >> ~/.bashrc

For Fedora (36):

sudo dnf install git cmake g++ zlib-devel python3-devel -y
git clone https://github.com/ics-jku/wal.git
cd wal
make install

For OpenSuse Tumbleweed:

sudo zypper install git cmake gcc-c++ zlib-devel python3-devel
git clone https://github.com/ics-jku/wal.git
cd wal
make install

Support for fst waveforms

To add support for the fst filetype to WAL, install the pylibfst package.

pip install --user pylibfst

PyPy and Pyston Support

WAL also supports the alternative Python implementations PyPy and Pyston. Both alternative implementations can lead to substantial speedups in a lot of scenarios. To install WAL with an alternative implementation change the PYTHON variable in the Makefile or install with PYTHON=pypy3 make install.

If you are using PyPy you must also have the python-dev package installed for PyPy3. On Ubuntu this package can be installed with 'sudo apt install pypy3-dev'.

Documentation

The WAL Programmer Manual is available on wal-lang.org.

Examples

To get an impression of WAL you can check out basic examples. Also, this ASCII cast ASCII Cast, shows how the WAL REPL is used to compare two RISCV cores.

WAWK

WAWK is a project building on top of the WAL language. It combines the waveform analysis of WAL with the programming Style of AWK. Internally, WAWK is transpiled to WAL expressions, showcasing how new languages can be build on top of WAL.

Publications

The initial paper on WAL was presented at ASPDAC'22 and can be downloaded here: https://www.ics.jku.at/files/2022ASPDAC_WAL.pdf. The examples from the paper can be found in the examples folder.

If you like WAL or found it useful, you can cite our paper as follows:

@InProceedings{KG:2022,
  author        = {Lucas Klemmer and Daniel Gro{\ss}e},
  title         = {{WAL:} A Novel Waveform Analysis Language for Advanced Design Understanding and Debugging},
  booktitle     = {ASP Design Automation Conf.},
  year          = 2022
}

WAL was also used in other publications for processor analysis, Spade HDL integration, pipeline visualization, and for a novel debug methodology.

Emacs Mode

A basic major mode for Emacs is available here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wal_lang-0.8.2.tar.gz (60.8 kB view details)

Uploaded Source

Built Distribution

wal_lang-0.8.2-py3-none-any.whl (72.4 kB view details)

Uploaded Python 3

File details

Details for the file wal_lang-0.8.2.tar.gz.

File metadata

  • Download URL: wal_lang-0.8.2.tar.gz
  • Upload date:
  • Size: 60.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for wal_lang-0.8.2.tar.gz
Algorithm Hash digest
SHA256 1e71dedf4117ee0faf6233c0210b4a46fc4e0f5c5add02d566249c3fea73dcef
MD5 d9300bb7a78ffb43d7f8e50ddef854b5
BLAKE2b-256 5403ebf3e2cd18dea923c3274a305f130a5641bb1030fa6604b488d913b6d971

See more details on using hashes here.

File details

Details for the file wal_lang-0.8.2-py3-none-any.whl.

File metadata

  • Download URL: wal_lang-0.8.2-py3-none-any.whl
  • Upload date:
  • Size: 72.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.0

File hashes

Hashes for wal_lang-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4f9667bd7948309281ede5253572e12765bd9704ab2cedcbbef4f3293fafc5c9
MD5 5201d57ef389ce2e5306449010b09630
BLAKE2b-256 619a569a951032745a9e568850962daec946c0ec6a352cd203a97243cee3a117

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page