Skip to content

Commit

Permalink
small changes to demo docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
bd-j committed Feb 20, 2022
1 parent 79060fd commit a3eeac7
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 13 deletions.
6 changes: 4 additions & 2 deletions demo/tutorial.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down
13 changes: 8 additions & 5 deletions doc/demo.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
.. _demo:

Demonstrations
===============
You can check out the Jupyter notebook demo at
==============

* `InteractiveDemo <https://github.com/bd-j/prospector/blob/main/demo/InteractiveDemo.ipynb>`_
You can check out the Jupyter notebook demo at the
`InteractiveDemo <https://github.com/bd-j/prospector/blob/main/demo/InteractiveDemo.ipynb>`_

Code used to make the fits and figures in the `prospector paper
<https://ui.adsabs.harvard.edu/abs/2021ApJS..254...22J/abstract>`_ is available
in `this <https://github.com/bd-j/exspect>`_ github repository.
<https://ui.adsabs.harvard.edu/abs/2021ApJS..254...22J/abstract>`_
is available in `this <https://github.com/bd-j/exspect>`_ github repository.


Interactive Figure
------------------
Expand Down
10 changes: 5 additions & 5 deletions doc/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion doc/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a3eeac7

Please sign in to comment.