Skip to content

CaltechOpticalObservatories/wdl

Repository files navigation

Waveform Definition Language (WDL) for Archons

Overview

WDL (Waveform Definition Language) is designed for use with Archons. This project provides tools and instructions for setting up and using WDL efficiently.

Requirements

System Requirements:

Python Packages:

The following Python packages are required:

  • numpy
  • scipy
  • matplotlib
  • pyqt
  1. Create a Virtual Environment: If you don't have venv installed, you can install it with:

    sudo apt install python3-venv  # For Ubuntu

    Create Command

    python -m venv venv 
  2. Activate the Virtual Environment: Once you have created your virtual environment, you need to activate it to start using it. Activation sets up your shell to use the Python interpreter and libraries from the virtual environment instead of the global Python environment.

    Activation Commands

  • On macOS and Linux:
    source venv/bin/activate
  1. Install Required Packages

    Once your virtual environment is activated, you can install the necessary Python packages listed in the requirements.txt file.

    Installation Command Run the following command to install the required packages:

    pip install -r requirements.txt

Setup Instructions

  1. Directory Structure:
    • It is recommended to keep WDL in a separate directory from your ACF source files.
  2. Copy the Makefile:
    • Copy the Makefile from the WDL directory to the directory containing your ACF source files.
  3. Update Paths in Makefile:
    • Edit the Makefile to update the following lines with the correct paths

      GPP       = /usr/local/bin/gpp
      WDLPATH   = $(HOME)/Software/wdl
      ACFPATH   = $(HOME)/Software/acf

      Ensure these paths point to your GPP executable, WDL directory, and ACF source files respectively.

  4. Run make
     $ make ${TARGET}

Demo Build

$ cd demo
$ make Demo

About

waveform definition language for Archons

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7