SCINT (Sensor Calibration Interface for Neutrino Team)

This is a Python library to process and analyze raw data from the lab (waveform per waveform mode).

📖 Access the DOCUMENTATION for more information

0 Download

Clone the repository into a local directory and create your branch:

git clone https://github.com/CIEMAT-Neutrino/SCINT.git
cd SCINT
git checkout -b <your_branch_name>

• You can create a test folder for your custom scripts or code.

• [OPTIONAL] Create a folder for your custom scripts and add them to the .gitignore file:

mkdir <your_folder_name>
echo "<your_folder_name/*>" >> .gitignore

1 To start RUN:

Set all the utilities needed for the macros:

source setup.sh
source .venv/bin/activate

2 Run the following macros FROM the macros' folder:

cd srcs/macros
python3 XXmacro.py (--flags input) 

CONTRIBUTING

🚧 Work in progress (check TO DO LIST) 🚧

• Make sure you create your branch or fork the repository for commiting your changes.

• The branch should tell something about the development you are carring out.

• Once you are sure your development is ready to be shared with the group open a pull request and merge to the main.

• Follow pep-8 style Python code (Black Formatter extension in VSCode will do the formatting for you)

• Document the code as you go! (Work in progress to homogenize style in the functions' doc)

  • Sphinx docstring format - VSCode Python Docstring Generator

  """[Summary]
  
  :param [ParamName]: [ParamDescription], defaults to [DefaultParamVal]
  :type [ParamName]: [ParamType](, optional)
  
  :raises [ErrorType]: [ErrorDescription]
  
  :return: [ReturnDescription]
  :rtype: [ReturnType]
  """

• We adopted a formatting style for functions, variables and so on:

  FUNCTIONS & ARGUMENTS → PYTHON NOTATION: low_case + “_” binding (i.e my_runs) 
  KEYS → C++ notation
  SPECIAL DICTIONARIES
      OPT: visualization Options + CHECK KEY

LICENSE

MIT

Authors (alphabetical order, please insert your name here if you contribute to this project)

• Alvárez-Garrote, Rodrigo
• de la Torre Rojo, Andrés
• Manthey Corchado, Sergio
• Pérez-Molina, Laura