Skip to content
Snippets Groups Projects
Commit ce350e45 authored by BARTHES Nicolas's avatar BARTHES Nicolas
Browse files

updated README.md

parent 043d73e1
No related branches found
No related tags found
No related merge requests found
......@@ -7,12 +7,14 @@ The process includes:
- sample selection - you can upload all your NIRS spectra and it'll help to select the samples to analyse chemically.
- model creation - the PINARD (https://github.com/GBeurier/pinard) package creates a prediction model with spectra and related chemical analysis.-
- model creation - the PINARD (https://github.com/GBeurier/pinard) package creates a prediction model with spectra and related chemical analysis.
More algorythms had been added like LWPLR from Jchemo (https://github.com/mlesnoff/Jchemo.jl), PLSR with wavelength selection, etc.
- predictions - the PINARD package uses the model to predict chemical values for unknown samples.
- predictions - the models are used to predict chemical values for unknown samples. We provide information for confidence in the predicted values depending on the samples and the model used.
If one wants to use data stored in a SQL database, the config file is in the config/ folder.
The SQL script to create the database is in this same folder.
## Installation
This package is written in python. You can clone the repository: git clone https://src.koda.cnrs.fr/CEFE/PACE/nirs_workflow.git
......@@ -34,16 +36,23 @@ You can then run (CLI): streamlit run ./app.py from within your src/ folder.
The app will open in your default browser.
## Usage
The web app allows you to process sample selection, model creation and predictions.
The web app allows you to process sample selection, model creation and predictions with a simple interface or the advanced one.
## Documentation
The doc is generated with mkDoc and Python DocStrings.
From CLI, run
> mkdocs serve
## Authors and acknowledgment
Contributors:
- Nicolas Barthes (CNRS)
-
- Abderrahim Diane (Montpellier University)
- Mouhcine Maimouni
- Rémy Beugnon
- Alexandre Granier (IRD)
- Vincent Nègre (CNRS)
We would like to thank Matthieu Lesnoff (CIRAD) for discussions and the Jchemo Toolbox.
## License
CC BY
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment