Skip to content
Snippets Groups Projects
README.md 1.47 KiB
Newer Older
BARTHES Nicolas's avatar
BARTHES Nicolas committed
# NIRS_Workflow

## Getting started
DIANE's avatar
DIANE committed
This package aims to provide a workflow for users who want to perform chemical analyses and predict characteristics using the NIRS technique.
BARTHES Nicolas's avatar
BARTHES Nicolas committed

The process includes:
- sample selection - you can upload all your NIRS spectra and it'll help to select the samples to analyse chemically.
DIANE's avatar
DIANE committed
- model creation - the PINARD (https://github.com/GBeurier/pinard) package creates a prediction model with spectra and related chemical analysis.-
- predictions - the PINARD package uses the model to predict chemical values for unknown samples.

If one wants to use data stored in a SQL database, the config file is in the config/ folder.

BARTHES Nicolas's avatar
BARTHES Nicolas committed
## Installation
This package is written in python. You can clone the repository: git clone https://src.koda.cnrs.fr/nicolas.barthes.5/nirs_workflow.git
BARTHES Nicolas's avatar
BARTHES Nicolas committed

Then install the requirements: pip install -r requirements.txt
DIANE Abderrahim's avatar
DIANE Abderrahim committed
To use Locally weighted PLS Regression for creation model, you will need to install Jchemo.jl (https://github.com/mlesnoff/Jchemo.jl), a Julia package.
DIANE's avatar
DIANE committed
From the CLI: python
> '>>> import julia
'>>> julia.install()
'>>> from julia import Pkg
'>>> Pkg.add("Jchemo")
DIANE's avatar
DIANE committed
To check if Jchemo is installed without errors:
Nicolas Barthes's avatar
Nicolas Barthes committed
> '>>> Pkg.status()
BARTHES Nicolas's avatar
BARTHES Nicolas committed

You can then run: streamlit run ./app.py from the CLI.
BARTHES Nicolas's avatar
BARTHES Nicolas committed

The app will then open in your default browser.
BARTHES Nicolas's avatar
BARTHES Nicolas committed

## Usage
The web app allows you to process sample selection, model creation and predictions.
BARTHES Nicolas's avatar
BARTHES Nicolas committed

## Authors and acknowledgment
Contributors:
- Nicolas Barthes (CNRS)
- 
BARTHES Nicolas's avatar
BARTHES Nicolas committed

## License
DIANE's avatar
DIANE committed
CC BY