Installation

VoigtFit is now available for Python 3! The code has been tested on 3.6 and 3.7. Support for Python 2.7 will be continued for a while but will eventually be dropped since Python 2.7 is no longer supported by the Python developers.

Please let me know that you’re using VoigtFit by filling in this short form. This way I can keep you updated with critical updates and I get an idea of how many users are still depending on Python 2.7 compatibility.

Dependencies

VoigtFit depends on matplotlib, numpy, scipy, h5py (>2.1), astropy, and lmfit. You can install these using your favorite Python package manager such as pip or conda.

Using pip

The easiest way to install the most recent stable version of VoigtFit is using pip:

%] pip install VoigtFit

If you encounter the following AttributeError when attempting to install via pip:

AttributeError: ‘NoneType’ object has no attribute ‘splitlines’

Try running pip with the --upgrade option:

%] pip install --upgrade VoigtFit

From source

Alternatively, you can get the source by downloading a tarball or cloning the git repository:

%] git clone https://github.com/jkrogager/VoigtFit.git

Once you’ve downloaded the source, you can navigate to the root directory and run:

%] python setup.py install

Test the installation

If the installation went smoothly, you should be able to run VoigtFit from the terminal by executing the following command:

%] VoigtFit

Running the program without any input will create an empty parameter file template. This way you can always set up a fresh parameter file when starting a new project. Moreover, as the program grows and more features are implemented, a comment about such new features will appear automatically in the parameter file template. This way you can stay updated on what is possible within the parameter file language.

To run the program with a given input file, simply execute the command:

%] VoigtFit  input.pars

Where input.pars is the name of your parameter file.