IDE File Command-Line Utilities#

idelib provides some useful command-line utilities for converting IDE data to other formats, and for viewing general information about an IDE file. These are automatically installed when installing the idelib package.

Getting Started#

Installing#

The utilities are part of the idelib package, so they are installed along with it. The common way to install is via pip (which is typically bundled with Python):

pip install idelib

Running the scripts#

These utilities can be run in two ways: via an executable script, or as a Python module.

Running as a Python module#

You can run the utilities by running Python with the -m argument, followed by the name of the submodule and any arguments, e.g.:

  • python -m idelib.tools.ideexport --help

  • python -m idelib.tools.ideinfo --help

  • python -m idelib.tools.idesync --help

While verbose, this is the most reliable way to run the utilities.

Running the executable#

When idelib is installed, it will create an executable file for each utility. The location of the scripts varies by operating system (Linux/Windows/MacOS/etc.) and by Python environment (e.g., standard Python from python.org or conda), but it should be in your ‘path’, so running it is done by typing its name, followed by any arguments:

  • ideexport --help

  • ideinfo --help

  • idesync --help

Unfortunately, there are many factors specific to your computer and Python setup that can interfere with this. Most commonly, the executables are somewhere outside of your ‘path’ and could not be found, or security/authorization issues prevented the executables’ creation. In either case, the result is the standard ‘not found’ error for your OS.

ideexport#

ideexport converts one or more IDE files into text (CSV, etc.) or Matlab MAT v5 files.

usage: ideexport.py [-h] [-o OUTPUT] [-t {csv,mat,txt}] [-c CHANNEL] [-m] [-u] [-n] [-r] [-d {comma,tab,pipe}] [-f] FILENAME.IDE [FILENAME.IDE ...]

Batch IDE Conversion Utility v3.4.0 - Copyright (c) 2026 Midé Technology

positional arguments:
  FILENAME.IDE          The source .IDE file(s) to convert. Wildcards permitted.

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        The output path to which to save the exported files. Defaults to the same location as the source file.
  -t {csv,mat,txt}, --type {csv,mat,txt}
                        The type of file to export.
  -c CHANNEL, --channel CHANNEL
                        Export the specific channel. Can be used multiple times. If not used, all channels will export.
  -m, --removemean      Remove the mean from accelerometer data.
  -u, --utc             Write timestamps as UTC 'Unix epoch' time.
  -n, --names           Include channel names in exported filenames.
  -s, --sync            Apply recordings' sychronization data (if present in the file).

Text Export Options (CSV, TXT, etc.):
  -r, --headers         Write 'header' information (column names) as the first row of text-based export.
  -d {comma,tab,pipe}, --delimiter {comma,tab,pipe}
                        The delimiting character, for exporting non-CSV text-based files.
  -f, --isoformat       Write timestamps as ISO-formatted UTC.

idesync#

idesync generates synchronization metadata, synchronizing one or more files to a ‘reference’ recording. This information, which is inserted into the recording, can be applied when exporting with ideexport --sync.

usage: idesync.py [-h] [-g] [-i] FILENAME.IDE [FILENAME.IDE ...]

Batch IDE Synchronization Utility v3.4.0b1 - Copyright (c) 2025 Midé Technology

positional arguments:
  FILENAME.IDE   The recording to which to synchronize the others, and/or adjustits starting time if --gps is used.
  FILENAME.IDE   Recordings to sync to the reference.

options:
  -h, --help     show this help message and exit
  -g, --gps      Update the reference recording's start time using its GPS/GNSS data. Cannot be used in conjunction wtih --inherit.
  -i, --inherit  If the reference recording has been synced to another, sync the other datasets to that (rather than the reference itself). Cannot be used in conjunction with --gps.

Note: The applied synchronization is not currently displayed when viewing recordings in enDAQ Lab (verion 3.1.1 or earlier).

ideinfo#

ideinfo gathers information about an IDE file, and either displays the text on the console or writes it to a file.

usage: ideinfo.py [-h] [-o OUTPUT] FILENAME.IDE [FILENAME.IDE ...]

IDE Info Viewer v3.4.0 - Copyright (c) 2026 Midé Technology

positional arguments:
  FILENAME.IDE          The source .IDE file(s) to convert. Wildcards permitted.

options:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        The output path to which to save the info text.
On this page
Show Source