MCALF: Multi-Component Atmospheric Line Fitting
Project description
MCALF is an open-source Python package for accurately constraining velocity information from spectral imaging observations using machine learning techniques.
This software package provides a ‘toolkit’ that can be used to define a spectral model optimised for a particular dataset. A sample model is provided for an IBIS Ca II 8542 Å spectral imaging sunspot dataset. This dataset typically contains spectra with multiple atmospheric components and this package supports the isolation of the individual components such that velocity information can be constrained for each component. Using this sample model, as well as the separate base (template) model it is built upon, a custom model can easily be built for a specific dataset.
Installation
$ pip install mcalfWe recommend installing this program inside a virtual environment. Alternatively, you can install Anaconda (or Miniconda), and then install the package using the above command inside an new conda environment.
Testing
First, install the package as usual, and then download the code associated with your installed MCALF version. Unzip the file and navigate to it in the terminal. Run the following command (in the same directory as setup.py) to test your installation,
$ python -m pytestMake sure you are inside the virtual environment where it was installed.
Getting Started
Some examples are included here. If you are interested in using this package in your research or you are interested in contributing to it, please contact Conor MacBride.
License
MCALF is licensed under the terms of the BSD 2-Clause license.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
