Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI access to dtscalibration #195

Open
BSchilperoort opened this issue Aug 11, 2023 · 2 comments
Open

CLI access to dtscalibration #195

BSchilperoort opened this issue Aug 11, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@BSchilperoort
Copy link
Collaborator

It could be nice to be able to run the calibration routines using a command line interface.

The calibration configuration could be specified in a yaml configuration file, for example:

name: "test_setup"
calibration-configuration:
    mode: "double-ended"
    align_channels: true
    sections:
        warm_bath:
            sensor: "Pt100_1"
            start: 10.50
            end: 21.15
        cold_bath:
            sensor: "Pt100_2"
            start: 25.60
            end: 35.45
@BSchilperoort BSchilperoort added the enhancement New feature or request label Aug 11, 2023
@bdestombe
Copy link
Collaborator

Could we use hatch for this, such that we don't have to worry about the environment?

@BSchilperoort
Copy link
Collaborator Author

This is more of a suggestion of a way to make a dtscalibration CLI, not on how to run it.

A CLI tool is quite easily configured in pyproject.toml, and can then be started by using any of the following commands (where site1-recipe.yml is the name of the yaml recipe file):

dtscalibration site1-recipe.yml
python -m dtscalibration site1-recipe.yml
hatch run dtscalibration site1-recipe.yml

But the goal of a calibration "recipe" and command line access it to allow for a clearly defined calibration routine that is easier to share/reuse and understand than python code.

This could be quite useful in a more permanent measurement setup, or some other professional monitoring environment. The routine could then also generate, for example, calibration validation plots and other statistics along with the calibrated temperatures.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

2 participants