Skip to content

Latest commit

 

History

History
63 lines (50 loc) · 2.67 KB

README.md

File metadata and controls

63 lines (50 loc) · 2.67 KB
Raw

endaq.batch-exe

This repo provides a command-line interfaced Windows-executable-file version of the endaq.batch module (provided by the endaq package).

Building the .exe

First, ensure you have Python 3.7-3.9 installed on your system. (The .exe may work on newer Python versions like 3.10, but will NOT work on older versions like 3.6 or earlier.) The instructions below assume your version of Python is accessible via python in the cmd terminal.

On a Windows machine, in the cmd terminal:

  • fetch the repo via git clone ..., or simply download the repo folder: 
     $ git clone https://github.com/MideTechnology/endaq-batch-exe.git
  • navigate to the repo folder: 
     $ cd endaq-batch-exe
  • make a venv to store the requisite Python dependencies, and activate the venv: 
     $ python -m venv venv
 $ venv\Scripts\activate
  • install the requisite Python dependencies (while in the venv): 
     $ python -m pip install -U pip setuptools
 $ python -m pip install -r requirements.txt
  • build the .exe with PyInstaller: 
     $ python -m PyInstaller main.spec --noconfirm

Usage

The executable is a CLI tool, and thus is accessible via the command line. (read: you can't just double-click the file and have it start working.)

Basic Example

With endaq-batch.exe in the current directory, you can run the program like so from the cmd terminal:

endaq-batch.exe --accel-highpass-cutoff=1 - add_metrics - add-peaks 1000 - add-psd 1 --window="hann" - add-pvss 1 12 - add_pvss_halfsine_envelope - add-vc-curves 1 12 - aggregate-data "path/to/files/*.IDE" - to-html-plots --show

This will:

  • generate a builder object with the add_peaks routine loaded
  • run the builder via aggregate_data on all IDE files in the folder "path\to\files"
  • call to_html_plots on the resulting OutputStruct, with show=True

For more details on what options and configurations are available, see the docs for endaq.batch

General Tips for CLI Usage

The functionality provided in this CLI is spread over several function calls that chain together into a single command, which is more complicated than what a typical CLI tool provides. Because of this complexity, the user has to be somewhat careful and pedantic about how the functions are called, and how variables are passed in.

Specifically, it's a good practice to separate each function call with a dash -, particularly if not all parameters for the function are explicitly specified. For examples:

  • do: 
    ... - add-psd 1 - add-pvss 1 12 - ...
  • do not: 
    ... add-psd 1 add-pvss 1 12 ...