peppedilillo / mescal

A software to calibrate the siswich detector payloads of the HERMES nanosatellite constellation.
MIT License
0 stars 0 forks source link

mescal

Hello and welcome to mescal, your favourite software to analyze data from the HERMES-SP payloads.

mescal's tui

Setup

The packages lmfit, joblib and rich, between others, are required to use mescal. We provide an environment.yml file to easily set up a conda environment in which you can run mescal. To create the environment from the environment.yml file, move to mescal's folder from your terminal and execute:

conda env create -f environment.yml

The command line interface of mescal is best rendered on modern terminal applications. We are redistributing two great modules by petereon@github, beaupy and yakh. All hail petereon and all rights reserved.

If you are working on windows, we suggest using mescal with the new Windows terminal!

Running mescal

The main goal of mescal is to calibrate the SDDs and scintillators of the HERMES's detector.

To launch mescal:

  1. Move to the mescal directory.
  2. Activate the mescal environment with conda activate mescal
  3. Launch python mescal.py
  4. Follow the instructions on screen.

Mescal can also be used to visualize data acquired with the HERMES detector.

Want to try it?

Here's a sample acquisition!

Need help?

A few options (e.g., output format, DAC presets..) can be activated via command line arguments. You can check these through mescal's helper: python mescal.py --help.

Uninstalling

conda remove -n mescal --all

It should do, if you followed the steps above.