From 3139fc9114a8dfd11ea470dd32a34a471bf4b146 Mon Sep 17 00:00:00 2001 From: Eric Charles Date: Tue, 10 Mar 2020 12:02:43 -0700 Subject: [PATCH] Doc updates (#318) * Updated doc * updated fermipy_diffuse.rst * Updated changelog.rst --- docs/changelog.rst | 8 +++++++- docs/fermipy_diffuse.rst | 26 +++++++++++++++++++++++++- docs/fermipy_jobs_tools.rst | 7 ++++--- 3 files changed, 36 insertions(+), 5 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 2c4bece9..f656c583 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,9 +6,15 @@ Changelog This page is a changelog for releases of Fermipy. You can also browse releases on `Github `_. +0.18.1 (03/10/2020) +------------------- +* Changes to improve automated builds for testing +* Added documentation for fermipy.jobs and femripy.diffuse modules +* Some changes to support different size pixels in different components +* Added gtpsf and gtdrm support to gtanalysis 0.18.0 (10/18/2019) ------------------- +------------------- * Added tools to use new version of energy dispersion from fermitools. * Changed travis testing and conda scripts to work with conda release of fermitools. diff --git a/docs/fermipy_diffuse.rst b/docs/fermipy_diffuse.rst index d722dee8..abd745ea 100644 --- a/docs/fermipy_diffuse.rst +++ b/docs/fermipy_diffuse.rst @@ -5,7 +5,22 @@ fermipy.diffuse subpackage The fermipy.diffuse sub-package is a collection of standalone utilities that allow the user to parallelize the data and template -preparation for all-sky diffuse analysis. +preparation for all-sky analysis. + +The tools described here perform a number of functions: + +* Making binned counts maps and expousre maps over the whole sky. + +* Managing model components for all-sky analysis; including both + diffuse emission and point source contributions. This includes + make spatial-spectral templates and expected counts maps + for various components. + +* Building intergrated models for a collection of model components. + +* Fitting those models. + + Overview @@ -52,6 +67,8 @@ The various loop variables are: + + .. code-block:: python @@ -533,6 +550,13 @@ library components and spectral models. +Examples +-------- + + + + + Module contents --------------- diff --git a/docs/fermipy_jobs_tools.rst b/docs/fermipy_jobs_tools.rst index 9ed567ef..94ba995a 100644 --- a/docs/fermipy_jobs_tools.rst +++ b/docs/fermipy_jobs_tools.rst @@ -196,9 +196,10 @@ Using Links and sub-classes in python The main aspect of the `Link` python interface are: * Building the `Link` and setting the parameters. By way of example we will -build a `Link` of type `AnalyzeROI` and configure it do a standard analysis of -the ROI using the file 'config.yaml' write the resulting -ROI snapshot to 'baseline' and make the standard validation plots. + build a `Link` of type `AnalyzeROI` and configure it do a standard analysis of + the ROI using the file 'config.yaml' write the resulting + ROI snapshot to 'baseline' and make the standard validation plots. + .. code-block:: python