Metadata-Version: 2.1
Name: uhina
Version: 0.0.2
Summary: 1D to 2D (Continuous Wavelet Transform) infrared spectra converter
Home-page: https://github.com/franckalbinet/uhina
Author: Franck Albinet
Author-email: franckalbinet@gmail.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastcore
Requires-Dist: pandas
Requires-Dist: scikit-learn
Requires-Dist: tqdm
Requires-Dist: pycwt
Provides-Extra: dev

# Uhina


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

> Converts 1D infrared spectra to 2D (Continuous Wavelet Transform)
> representations.

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

### Install uhina in Development mode

``` sh
# make sure uhina package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to uhina
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/franckalbinet/uhina):

``` sh
$ pip install git+https://github.com/franckalbinet/uhina.git
```

or from [pypi](https://pypi.org/project/uhina/)

``` sh
$ pip install uhina
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/franckalbinet/uhina)’s
[pages](https://franckalbinet.github.io/uhina/). Additionally you can
find package manager specific guidelines o
[pypi](https://pypi.org/project/uhina/) respectively.

## How to use

``` sh
usage: uh [-h] [--img_dir IMG_DIR] [--dataset DATASET] [--spectra_type SPECTRA_TYPE] [--analytes ANALYTES] [--n_samples N_SAMPLES] [--batch_size BATCH_SIZE]
          src dir_out

Convert spectra to wavelet images.

positional arguments:
  src                          Source file
  dir_out                      Output root directory

options:
  -h, --help                   show this help message and exit
  --img_dir IMG_DIR            Image directory (default: img)
  --dataset DATASET            Dataset to use (default: ossl)
  --spectra_type SPECTRA_TYPE  Spectra type to use (default: mir)
  --analytes ANALYTES          Analytes to use (default: k.ext_usda.a725_cmolc.kg)
  --n_samples N_SAMPLES        Number of samples to use
  --batch_size BATCH_SIZE      Batch size to use (default: 10)
```
