From a3eeac7b45e11c1724524f6a0125e58036490a73 Mon Sep 17 00:00:00 2001 From: Benjamin Johnson Date: Sun, 20 Feb 2022 13:34:08 -0500 Subject: [PATCH] small changes to demo docs. --- demo/tutorial.rst | 6 ++++-- doc/demo.rst | 13 ++++++++----- doc/models.rst | 10 +++++----- doc/quickstart.rst | 3 ++- 4 files changed, 19 insertions(+), 13 deletions(-) diff --git a/demo/tutorial.rst b/demo/tutorial.rst index ddc29de5..7d724805 100644 --- a/demo/tutorial.rst +++ b/demo/tutorial.rst @@ -1,5 +1,7 @@ +.. _tutorial: + Tutorial -============ +======== Here is a guide to running |Codename| fits from the command line using parameter files, and working with the output. This is a generalization of the techniques @@ -24,7 +26,7 @@ This is just an example. In practice |Codename| can work with a wide variety of data types. The parameter file ----------------------- +------------------ Open up ``demo_params.py`` in an editor, preferably one with syntax highlighting. You'll see that it's a python file. It includes some imports, a diff --git a/doc/demo.rst b/doc/demo.rst index 8d6a6652..478cd309 100644 --- a/doc/demo.rst +++ b/doc/demo.rst @@ -1,12 +1,15 @@ +.. _demo: + Demonstrations -=============== -You can check out the Jupyter notebook demo at +============== - * `InteractiveDemo `_ +You can check out the Jupyter notebook demo at the +`InteractiveDemo `_ Code used to make the fits and figures in the `prospector paper -`_ is available -in `this `_ github repository. +`_ +is available in `this `_ github repository. + Interactive Figure ------------------ diff --git a/doc/models.rst b/doc/models.rst index c2b6a2b2..89c06f9f 100644 --- a/doc/models.rst +++ b/doc/models.rst @@ -29,10 +29,10 @@ type of data to various parameters. Parameter Specification ------------------------------ -All model parameters are specified in a **parameter file**. A dictionary of -parameter specifications, keyed by parameter name, is used to instantiate and -configure the model objects (instances of :py:class:`models.ProspectorParams`` -or its subclasses.) +A model is defined by a dictionary of parameter specifications, keyed by +parameter name, that is used to instantiate and configure the model objects +(instances of :py:class:`models.ProspectorParams` or its subclasses.) This +dictionary is usually constructed or given in a **parameter file**. For a single parameter the specification is a dictionary that should at minimum include several keys: @@ -187,7 +187,7 @@ inspect the free and fixed parameters in a given set, you can do something like print(TemplateLibrary["parametric_sfh"]) # Actually get a copy of one of the predefined sets model_params = TemplateLibrary["parametric_sfh"] - # This dictionary can be updated or modified, e.g. to add default nebular emission parameters. + # This dictionary can be updated or modified, to expand the model. model_params.update(TemplateLibrary["nebular"]) # Instantiate a model object from prospect.models import SedModel diff --git a/doc/quickstart.rst b/doc/quickstart.rst index 8ddef2ab..df02dfa3 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -3,7 +3,8 @@ Quickstart Here's a quick intro that fits 5-band SDSS photometry with a simple delay-tau parametric SFH model. This assumes you've successully installed prospector and -all the prerequisites +all the prerequisites. This is intended simply to introduce the key +ingrediants; for more realistic usage see :ref:`demo` or the :ref:`tutorial`. .. code:: python