Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gmzsebastian committed Sep 21, 2023
1 parent ff0ec16 commit 8e4fa3b
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 14 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ MANIFEST
# Sphinx
docs/api
docs/_build
docs/_static

# Eclipse editor project files
.project
Expand Down
25 changes: 14 additions & 11 deletions docs/basic_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ population parameters. In this example, we will create the following:

#. A stellar population representing a global cluster with:

* 10000 stars
* 100 stars
* An age of 7.5 billion years
* A metallicity of -2.0
* A Salpeter IMF with alpha = -2.35
Expand All @@ -81,12 +81,16 @@ population parameters. In this example, we will create the following:

.. code-block:: python
obs_prefix = 'notebook_example'
obs_ra = 150.0
obs_dec = -2.5
from stips.scene_module import SceneModule
scm = SceneModule(out_prefix=obs_prefix, ra=obs_ra, dec=obs_dec)
stellar_parameters = {
'n_stars': 10000,
'n_stars': 100,
'age_low': 7.5e12,
'age_high': 7.5e12,
'z_low': -2.0,
Expand All @@ -98,12 +102,12 @@ population parameters. In this example, we will create the following:
'distribution': 'invpow',
'radius': 100.0,
'radius_units': 'pc',
'distance_low': 10.0,
'distance_high': 10.0,
'distance_low': 20.0,
'distance_high': 20.0,
'offset_ra': 0.0,
'offset_dec':0.0
}
'offset_dec': 0.0
}
stellar_cat_file = scm.CreatePopulation(stellar_parameters)
print("Stellar population saved to file {}".format(stellar_cat_file))
Expand All @@ -113,7 +117,7 @@ population parameters. In this example, we will create the following:
'z_high': 0.2,
'rad_low': 0.01,
'rad_high': 2.0,
'sb_v_low': 28.0,
'sb_v_low': 30.0,
'sb_v_high': 25.0,
'distribution': 'uniform',
'clustered': False,
Expand All @@ -122,10 +126,9 @@ population parameters. In this example, we will create the following:
'offset_ra': 0.0,
'offset_dec': 0.0,
}
galaxy_cat_file = scm.CreateGalaxies(galaxy_parameters)
print("Galaxy population saved to file{}".format(galaxy_cat_file))
print("Galaxy population saved to file {}".format(galaxy_cat_file))
Creating a STIPS Observation
----------------------------
Expand Down
12 changes: 11 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def setup(app):
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../'))

'''
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
Expand All @@ -59,6 +59,15 @@ def setup(app):
'sphinx_automodapi.automodapi',
'autoapi.extension',
]
'''
extensions = [
'sphinx.ext.intersphinx',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'sphinx_rtd_theme',
]

numpydoc_show_class_members = False

Expand Down Expand Up @@ -92,6 +101,7 @@ def setup(app):

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
#pygments_style = 'default'

# -- Options for HTML output --------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ in this section along with instructions.
STIPS Requirements
##################

\• ``pandeia>=1.7``: Exposure time calculator.
\• ``pandeia>=3.0``: Exposure time calculator.

\• ``webbpsf==1.1.0``: Nancy Grace Roman PSF calculator. STIPS also requires that ``poppy``, a
\• ``webbpsf==1.1.1``: Nancy Grace Roman PSF calculator. STIPS also requires that ``poppy``, a
support package used by WebbPSF, have version ``>=1.0.3``.

\• ``astropy``: STIPS uses Astropy in order to:
Expand Down

0 comments on commit 8e4fa3b

Please sign in to comment.