Metadata-Version: 2.1
Name: AdaptFTIR
Version: 0.1.0
Summary: Domain adaptation for FTIR spectra
Home-page: https://github.com/Niklas-LK/AdaptFTIR
Author: Niklas Leopold-Kerschbaumer
Author-email: niklas.leopold-kerschbaumer@hotmail.com
License: MIT
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: typing

# AdaptFTIR

## Description
This repository contains a Python implementation of the AdaptFTIR method described in the paper entitled "**Title**" (doi url).

## Installation
The package is available via PyPI:
```bash
pip install AdaptFTIR
```

## Usage
For detailed information on how to initialize the AdaptFTIR method and configure its parameters, please refer to the `example_usage.ipynb` Jupyter Notebook and the code documentation in the `AdaptFTIR.py` file. The basic usage format is as follows:
```python
from AdaptFTIR import AdaptFTIR

# Initialize an instance of AdaptFTIR with a calibration set
adapter = AdaptFTIR(spectra=<your_spectra_to_augment>,
              subject_ids=<your_subject_ids_for_spectra_to_augment>,
              calibration_set=<your_calibration_set>,
              calibration_ids=<your_calibration_set_subject_ids>)

# Create synthetic samples based on an input set of training samples X and associated sample labels y
X_gen, y_gen = AdaptFTIR.run(n_per_subject_id=<your_n_per_subject_id>)

```

## Citation
> Citation goes here
