Skip to content

Commit

Permalink
Doc updates (#318)
Browse files Browse the repository at this point in the history
* Updated doc

* updated fermipy_diffuse.rst

* Updated changelog.rst
  • Loading branch information
eacharles authored Mar 10, 2020
1 parent 3ab84c2 commit 3139fc9
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 5 deletions.
8 changes: 7 additions & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,15 @@ Changelog
This page is a changelog for releases of Fermipy. You can also browse
releases on `Github <https://github.com/fermiPy/fermipy/releases>`_.

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.

Expand Down
26 changes: 25 additions & 1 deletion docs/fermipy_diffuse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -52,6 +67,8 @@ The various loop variables are:






.. code-block:: python
Expand Down Expand Up @@ -533,6 +550,13 @@ library components and spectral models.



Examples
--------





Module contents
---------------

Expand Down
7 changes: 4 additions & 3 deletions docs/fermipy_jobs_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3139fc9

Please sign in to comment.