Badges

(Customize these badges with your own links, and check https://shields.io/ or https://badgen.net/ to see which other badges are available.)

fair-software.eu recommendations
(1/5) code repository
(2/5) license
(3/5) community registry
(4/5) citation
(5/5) checklist
howfairis
Other best practices
GitHub Actions
Build

Documentation

This is for the FINESSE instrument at Imperial. It is processing code that includes calibration and plotting. This is only python code, there is also an IDL version. Run the code within the Python multi folder.

Here is a description of what each of the script files currently does:

• File 0 is just reading the sensors to track BB temperatures, PRT sensors and vaisala instrument pressure temperature humidity + co2

• File 1 is preparing the interferograms for single or multi (averaged 40)

• File 2 is calculating the response functions (always done in multi case)

• File 3a single is doing calibration for single case [NOTE THIS CODE IS NOT FINISHED]

• File 3b multi is doing calibration for multi case

Quick plot file:

• For checking the final calibration spectra output
• Features to add: Time evolution plots

How to use finesse_processing

Code for calibrating FINESSE interferograms.

The project setup is documented in project_setup.md. Feel free to remove this document (and/or the link to this document) if you don't need it.

For developers

Download the code

First you need to clone the repository:

git clone [email protected]:ImperialCollegeLondon/finesse_processing.git

(Optionally) make a virtual environment

We recommend that you create a virtual environment for FINESSE_processing to keep the packages installed separate. You can do this like so:

python -m venv .venv

You then need to activate it for your shell. If you are using bash then you can run:

source .venv/bin/activate

(If you are using a different shell, then there are other scripts in the .venv/bin folder you can use instead.)

Install the developer dependencies

Next you will want to install the dependencies for FINESSE_processing along with the developer tools required to work on the project.

You can do this like so:

pip install -e .[dev,scripts]

Install pre-commit

This project contains a configuration file for pre-commit, a tool which automatically runs specified checks every time you make a commit with Git. The pre-commit command-line tool will be installed along with the other developer dependencies, but you also have to enable it for this repository, like so:

pre-commit install

Now, whenever you make a Git commit, your changes will be checked for errors and stylistic problems. (For a list of the hooks enabled for this repository, see the configuration file).

The pre-commit hooks will also be run on every pull request by pre-commit.ci.

src folder

This will eventually contain all the functions needed to run the processing code. We will then reach out about how to better package these in the end of November 2024

Credits

This package was created with Copier and the NLeSC/python-template.