Utilities for iorodeo's open colorimeter
Project description
Utilities for IO Rodeo's Open Colorimeter
Installation
This package uses the poetry dependency manager. The installation instructions for poetry can be found here
Once poetry is installed the open-colorimeter-utils package can be installed using
$ poetry install
Additional documentation on using poetry can be found here
Using the Open Colorimeter calibration tool
The Open Colorimeter calibration tool "oc-cal" is a command line program which can fit calibratin data and generate the calibration.json used by the Open Colorimeter.
Usage: oc-cal [OPTIONS] [INPUT_FILES]...
Generates an Open Colorimeter calibration .json file from the .toml input
files
.toml file format
-----------------
name = "TestName" # Name of the test
led = 630 # Led wavelength
units = "ppm" # Measurement units
fit_type = "polynomial" # Fit type, polynomial or linear
fit_order = 2 # Order of the fit
values = [ # Array of measurements
[c0, c1, .... , cn], # Measurements in units
[a1, a1, .... , an] # Corresponding absorbances
]
Options:
-o, --output-file FILENAME output file
--help Show this message and exit.
The input calibration data is provided in the from of one of more .toml files with the following format
name = "Nitrite API"
led = 520
units = "ppm"
fit_type = "polynomial"
fit_order = 2
values = [
[0.00, 0.40, 0.80, 1.20, 1.60, 2.00], # concentration
[0.00, 0.30, 0.59, 0.88, 1.14, 1.39], # absorbance
]
In order to generate the calibrations simple run
$ oc-cal nitrite.toml
The oc-cal program will generate the calibrations.json file used by the open colorimeter. An alternative name can be given to this file using the -o of --output options.
An example of the calibrations.json file generated using the data from the .toml file above is shown below
{
"Nitrite API": {
"units": "ppm",
"led": "520",
"fit_type": "polynomial",
"fit_coef": [
0.11543984594053638,
1.2747960322708907,
0.0
],
"range": {
"min": 0.0,
"max": 1.39
}
}
}
In addtion the oc-cal program will fit the data and plots the results as shown below.
An example of calibrations.json file made using multiple .toml input files is shown below
{
"Ammonia API": {
"units": "ppm",
"led": "630",
"fit_type": "polynomial",
"fit_coef": [
1.0128521350438369,
1.890930808804952,
0.0
],
"range": {
"min": 0.0,
"max": 2.0
}
},
"Nitrate API": {
"units": "ppm",
"led": "520",
"fit_type": "polynomial",
"fit_coef": [
0.32039213453320625,
34.032597696304,
0.0
],
"range": {
"min": 0.0,
"max": 1.47
}
},
"Nitrite API": {
"units": "ppm",
"led": "520",
"fit_type": "polynomial",
"fit_coef": [
0.13111937060865314,
1.2591439203550079,
0.0
],
"range": {
"min": 0.0,
"max": 1.4
}
}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for open_colorimeter_utils-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fad85918da505aef006b42c0419b802610631afa76af63ac62c5cad23ddae544 |
|
MD5 | 8d33c40b19bd12842990101a205828f6 |
|
BLAKE2b-256 | 104a20b0840eef085e0e0bdb511dde776fdc313fa9e37a4c9cedb394e14c3d9c |
Hashes for open_colorimeter_utils-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df52e086cc9d58fa096a0f043cbf684e2ac9014d33e0053d472e58f2baa5d5ea |
|
MD5 | a0a4c515edc6501ef834067731ddc959 |
|
BLAKE2b-256 | a1fc9bf3f6aec1ed229b5de2d8a09c555953d5ec086ed6dede53419d6c4fea9c |