Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Commit

Permalink
Merge pull request #48 from dstansby/clean-doc-index
Browse files Browse the repository at this point in the history
Clean doc landing page
  • Loading branch information
dstansby committed Mar 6, 2023
2 parents aa27359 + 6450594 commit 24f4d42
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ demcmc

A package for estimating differential emission measures (DEMs) from observations of the Sun using Monte Carlo methods.

``demcmc`` provides an interface for collecting information on emission lines together in one place (a list of `EmissionLine` objects), and running a DEM inversion on them (using :func:`~demcmc.mcmc.predict_dem_emcee`).
``demcmc`` provides an interface for collecting information on emission lines together in one place (a list of `EmissionLine` objects), and running a DEM inversion on them (using :func:`~demcmc.predict_dem_emcee`).
Each `EmissionLine` object contains the intensity of an observed line, and the contribution function of that line.
The inversion is carried out using Markov chain Monte carlo (MCMC) methods, with the `emcee package <https://emcee.readthedocs.io/en/stable/>`__ used to run the sampling.

``demcmc`` does **not** make opinionated choices on *how* to run the the MCMC algorithm.
``demcmc`` does **not** make opinionated choices on how to run the the MCMC algorithm.
Users are forced to choose the number of MCMC steps and walkers, and are given the outputs needed to evaluate whether their choices are appropriate.
Before using this package it is highly recommended to read the `emcee paper <https://doi.org/10.48550/arXiv.1202.3665>`__ to understand how the sampling works, and what to choose for the MCMC parameters.

Expand Down

0 comments on commit 24f4d42

Please sign in to comment.