Echelle Spectra

Graphical tool for the extraction and analysis of calibrated spectra from 2D Echelle spectrometer images

Start with Venv • Quick start • Usage • Configuration • Authors • License

Install with venv

There are plentiful ways to install a package, but for now we recommend venv. Clone the repo into your folder of choice (use . to put it inside current dir)

git clone https://github.com/queezz/echelle_spectra.git .

Install a venv locally in the project folder

python -m venv ./.venv/echelle

Activate it

./.venv/echelle/Scripts/Activate.ps1

Update pip

python -m pip install -U pip

Install echelle_spectra in editable mode with dev tools:

python -m pip install -e ".[dev]"

Run the GUI program

python ./src/echelle_spectra/__main__.py

External venv

If you use your code with some cloud, it may be better to keep venv oustide the cloud storage. Then put venvs somewhere central. On Windows: $env:USERPROFILE\.venvs\ is a goood place.

python -m venv $env:USERPROFILE\.venvs\echelle

Activate

& $env:USERPROFILE\.venvs\echelle\Scripts\Activate.ps1

Quick start

Run GUI from python:

import echelle_spectra
echelle_spectra.gui.start()

Or from the command prompt:

python ./src/echelle_spectra/__main__.py

Usage

With the Echelle Spectra GUI open, you will be presented with a set of blank image and spectra plots, as well as a control panel of settings and information on the left.

Firstly, an image file containing data from an Echelle spectrometer needs to be loaded. During the loading process, each frame of the file is converted to a calibrated wavelength-intensity spectrum, and fitting to regions of interest in the spectrum is carried out if requested. Optionally, all spectral and fitting data is saved to disk, which can be imported by another application.

After a file is successfully loaded, the first frame will be graphically displayed in the image viewer, and the corresponding computed spectrum will be shown below it. The control panel on the left can be used to select which frame from the file is being visualised.

Other tabs are also available in the GUI, which contain plots populated by snippets of spectral data in common regions of interest. If fitting was enabled during loading, a convolution of one or more Gaussian curves is plotted that best approximates the emissive intensity in those wavelength regions.

GUI