Getting Started

Installation

Install PyIRD using pip:

pip install pyird

or by cloning the GitHub repository:

git clone https://github.com/prvjapan/pyird.git
cd pyird
pip install .

Verify Installation

To verify that PyIRD is correctly installed, run:

python -m pyird --version

or simply import it in Python:

import pyird
print(pyird.__version__)

Running the Tutorial

You can follow the tutorial provided in Pipeline to Get 1D Spectra from Raw Data (IRD Stream) to learn how to process and analyze IRD data step-by-step.

Note

The tutorial script IRD_stream.py is located in the examples/python/ folder.

Before running the tutorial, make sure that the sample data (from Zenodo) is extracted in the correct directory.

Sample Data

The raw data used in the tutorial (IRD_stream.py) can be downloaded from the Zenodo repository. The total file size after extraction is approximately 7 GB.

Input Data Overview

For details about supported input data formats, see Input Data.

Next Steps