Skip to main content

Read/Write ACQ Spectrum Files

Project description

Read EDGES ACQ spectrum files.

https://travis-ci.org/edges-collab/read_acq.svg?branch=master https://codecov.io/gh/edges-collab/read_acq/branch/master/graph/badge.svg https://img.shields.io/badge/code%20style-black-000000.svg

Installation

In a new/existing python environment, run pip install git+https://github.com/edges-collab/read_acq.

If you wish to develop read_acq, do the following:

git clone https://github.com/edges-collab/read_acq
cd read_acq
pip install -e .

Usage

read_acq can be used in a Python interpreter or directly via the command line.

CLI

To use the CLI, a single command is provided:

acq convert <data.acq> [<data2.acq> …] [-f format1 [-f format2]]

This will convert the file(s) provided to all formats provided, and place any resulting files in the same location as the original datafile(s) (but with different extension). The default format is ‘mat’. The command can be run from anywhere on the system, and the file given can be a relative or absolute path.

Multiple data files can be given, and each will be converted. Wildcards may also be used in any of the filenames, eg.:

acq convert data/*.acq

Library

The main point of entry for the Python interface is decode_file:

>>> from read_acq import decode_file
>>> data = decode_file("my_data.acq", write_formats=[])

By default, this function will also write the file in .mat format, but you can turn that off by providing write_formats=[]. The output is a numpy array of the data. Several more options are provided, use help(decode_file) in an interpreter to see all the options.

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

read_acq-1.0.0.tar.gz (738.5 kB view details)

Uploaded Source

File details

Details for the file read_acq-1.0.0.tar.gz.

File metadata

  • Download URL: read_acq-1.0.0.tar.gz
  • Upload date:
  • Size: 738.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for read_acq-1.0.0.tar.gz
Algorithm Hash digest
SHA256 683fd7cee2920307b20c0d9401558d78ab8cd8a9c6fc1fa86589c59e804c6887
MD5 09b09b8c8b3c9518775ca391c619bd99
BLAKE2b-256 70e958a654c8571a54cc4c39bb72954f8ece785d9164b3fac655b45b6749c92d

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