Package: eispac
EISPAC - EIS Python Analysis CodeThis software provides a set of tools for analyzing Hinode/EIS data within a
Python environment. The general approach is as follows:Sets of level 1 HDF5 files are processed from the latest EIS level-0 fits files
and made available online by the NRL EIS team athttps://eis.nrl.navy.mil/.
The HDF5 files come in pairs of "data" and "header" files which contain corrected
count rates, the calibration curve needed to convert counts into intensity,
and all of the associated metadata and pointing information.This package provides Python classes and functions that can read these hdf5
files, perform all of the necessary calibration and pointing adjustments, and
create user-friendly python objects that can be manipulated as needed. Also
included are functions for fitting the intensity profiles using the same
template files and underlying methodology that is used in the IDL SolarSoft
environment.Getting StartedInstall using PIP (recommended) or by manually downloading this repo.Read through theOnline User's Guide(PDF download)Quick Guide:
A brief overview of the core EISPAC functions and objects.Command Line Tools:
Description of some command line tools available for searching, downloading, and fitting
EIS observations.Need help? If you have any questions, bug reports, or feature requests; please open
an issue or email the development team.Want to contribute code? Please see theCommunity Guidelinessection of the online documentation.InstallationUsing PIPEISPAC is now available on PyPI. To install, just use the following command,> python -m pip install eispacTo upgrade the package, please use:> python -m pip install --upgrade eispacpip should automatically install all package dependencies. If it does not, please
see the list of required packages below. Note: if you are using conda to manage your
Python packages, you may wish to install or update the dependencies manually first,
before installing eispac using pip (this is by no means required, but it can help
simplify updating packages).Manual InstallDownload or clone "eispac" to a convenient location on your computer (it does not matter where).> git clone https://github.com/USNavalResearchLaboratory/eispac.gitOpen a terminal and navigate to the directoryTo install:> python -m pip install .To upgrade:> python -m pip install --upgrade .The package should then be installed to the correct location for your current Python
environment. You can now import the package usingimport eispac.Required Packagespython >= 3.8numpy >= 1.18scipy >= 1.4matplotlib >= 3.1h5py >= 2.9astropy >= 4.2.11sunpy >= 4.0ndcube >= 2.0.0parfive >= 1.5python-dateutil>=2.8Code OrganizationThere are currently three core directories:eispac: main python code directory containing all of the programs required to
read level 1 HDF5 files and fit templates and fit spectra using mpfit.Notable subdirectories:../eispac/core/:  Main code directory. All functions here are loaded into the
top-level namespace (i.e. eispac.{function name})../eispac/data/: Contains fitting templates for specific spectral lines. These HDF5
files are direct conversions of the ".genx" files used by some IDL users. Also included
is an example EIS raster from 2021-03-06 at 06:44:44.scripts: GUI and command line toolsdocs: Source reStructuredText files used to build the online documentationIt should also be noted thatmpfit.pywas written by Mark Rivers and Sergey Kopsov and
is a direct Python port of thempfit.proIDL procedure written by Craig Markwardt. As such,
much of the documentation online for the IDL version of the code is still applicable to the
Python version (see also thempfitsection of our docs for more information).TODO listHere, in no particular order, is a list of some things that may be added in future releases.Expanded documentationMore unit and integration testsMore detailed logging (with option to send all log information to a file)Scripts for quickly viewing data and spectra fitsScripts and routines for creating new fit templatesConsider adding a subclass ofNDCubeSequencewhich can hold multiple spectral windowsConsider storing the output fit parameters in anotherNDCubeRestructure project to use the Sunpy affiliated package template?