Welcome to Fermipy’s documentation!
Introduction
This is the Fermipy documentation page. Fermipy is a python package that facilitates analysis of data from the Large Area Telescope (LAT) with the Fermi Science Tools. For more information about the Fermi mission and the LAT instrument please refer to the Fermi Science Support Center.
The Fermipy package is built on the pyLikelihood interface of the Fermi Science Tools and provides a set of high-level tools for performing common analysis tasks:
Data and model preparation with the gt-tools (gtselect, gtmktime, etc.).
Extracting a spectral energy distribution (SED) of a source.
Generating PS/TS and residual maps for a region of interest.
Finding new source candidates.
Localizing a source or fitting its spatial extension.
Fermipy uses a configuration-file driven workflow in which the
analysis parameters (data selection, IRFs, and ROI model) are defined
in a YAML configuration file. Analysis is executed through a python
script that calls the methods of GTAnalysis to
perform different analysis operations.
For instructions on installing Fermipy see the Installation page. For a short introduction to using Fermipy see the Quickstart Guide. For more detailed examples see the Tutorials.
Getting Help
If you have questions about using Fermipy please open a GitHub Issue or email the Fermipy developers.
Acknowledging Fermipy
To acknowledge Fermipy in a publication please cite Wood et al. 2017.
Fermipy Team
fermipy is currently supported by a Fermi G. I. proposal (Proposal number 161029, P.I. Omodei) Project & Team
Documentation Contents
- Project & Team
- Installation
- Quickstart Guide
- Tutorials
- Configuration
- Output File
- ROI Optimization and Fitting
- Customizing the Model
- Developer Notes
- Advanced Analysis Methods
- Validation Tools
- fermipy package
- fermipy.config module
- fermipy.defaults module
- fermipy.gtanalysis module
- fermipy.logger module
- fermipy.roi_model module
- fermipy.utils module
angle_to_cartesian()apply_minmax_selection()arg_to_list()center_to_edge()collect_dirs()convolve2d_disk()convolve2d_gauss()cov_to_correlation()create_dict()create_hpx_disk_region_string()create_kernel_function_lookup()create_model_name()create_radial_spline()create_source_name()create_xml_element()decode_list()dot_prod()edge_to_center()edge_to_width()ellipse_to_cov()eq2gal()eval_radial_kernel()extend_array()find_function_root()find_rows_by_string()fit_parabola()fits_recarray_to_dict()format_filename()gal2eq()get_bounded_slice()get_parameter_limits()get_region_mask()init_matplotlib_backend()interpolate_function_min()is_fits_file()isstr()join_strings()load_data()load_npy()load_xml_elements()load_yaml()lonlat_to_xyz()make_cdisk_kernel()make_cgauss_kernel()make_disk_kernel()make_gaussian_kernel()make_pixel_distance()make_psf_kernel()make_radial_kernel()match_regex_list()memoize()merge_dict()merge_list_of_dicts()met_to_mjd()mkdir()onesided_cl_to_dlnl()onesided_dlnl_to_cl()overlap_slices()parabola()path_to_xmlpath()poly_to_parabola()prettify_xml()project()rebin_map()resolve_file_path()resolve_file_path_list()resolve_path()scale_parameter()separation_cos_angle()split_bin_edges()strip_suffix()sum_bins()tolist()twosided_cl_to_dlnl()twosided_dlnl_to_cl()unicode_representer()unicode_to_str()update_bounds()update_keys()val_to_bin()val_to_bin_bounded()val_to_edge()val_to_pix()write_yaml()xmlpath_to_path()xyz_to_lonlat()
- fermipy.plotting module
- fermipy.sed module
- fermipy.sourcefind module
- fermipy.spectrum module
- fermipy.skymap module
- fermipy.castro module
- fermipy.tsmap module
- fermipy.residmap module
- fermipy.lightcurve module
- Module contents
- fermipy.jobs subpackage
- fermipy.diffuse subpackage
- Overview
- Configuration
- Top Level Configuration
- Binning Configuration
- Dataset Configuration
- GALProp Rings Configuration
- Catalog Component Configuration
- Model Component Library
- Spectral Model Configuration
- Model Defintion
- Examples
- Module contents
- Configuration, binning, default options, etc…
- Utilities and tools
- Helper classes to manage model building
- Trivial Link Sub-classes
- Standalone Analysis Links
- Batch job dispatch classes
- Analysis chain classes
- Changelog
- 1.3.1 (08/20/2024)
- 1.3.0 (08/20/2024)
- 1.2.2 (01/21/2024)
- 1.2.1 (12/08/2023)
- 1.2 (09/21/2022)
- 1.1.6 (07/19/2022)
- 1.1.5 (07/18/2022)
- 1.1.4 (06/24/2022)
- 1.1.3 (06/04/2022)
- 1.1.2 (05/26/2022)
- 1.1.1 (05/13/2022)
- 1.1 (05/10/2022)
- 1.0.1 (03/12/2021)
- 1.0.0 (10/1/2020)
- 0.20.0 (08/24/2020)
- 0.19.0 (03/25/2020)
- 0.18.1 (03/10/2020)
- 0.18.0 (10/18/2019)
- 0.17.4 (3/13/2019)
- 0.17.3 (7/12/2018)
- 0.17.2 (5/30/2018)
- 0.17.1 (5/23/2018)
- 0.17.0 (5/22/2018)
- 0.16.0 (12/27/2017)
- 0.15.0 (09/05/2017)
- 0.14.0 (03/28/2017)
- 0.13.0 (01/16/2017)
- 0.12.0 (11/20/2016)
- 0.11.0 (08/24/2016)
- 0.10.0 (07/03/2016)
- 0.9.0 (05/25/2016)
- 0.8.0 (05/18/2016)