Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jzuhone committed Sep 11, 2024
1 parent 662b354 commit 7d548bb
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 5 deletions.
16 changes: 13 additions & 3 deletions acispy/thermal_models.py
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,8 @@ def from_states_file(cls, name, states_file, **kwargs):
format as "states.dat" which is outputted by ACIS
thermal model runs for loads.
Notes
-----
All other keyword arguments which are passed to the main
:class:`~acispy.thermal_models.ThermalModelRunner`
constructor can be passed to this method as well.
Expand All @@ -738,6 +740,8 @@ def from_commands(cls, name, cmds, **kwargs):
cmds : list of commands or CommandTable
The commands from which to derive states.
Notes
-----
All other keyword arguments which are passed to the main
:class:`~acispy.thermal_models.ThermalModelRunner`
constructor can be passed to this method as well.
Expand All @@ -763,13 +767,17 @@ def from_backstop(cls, name, backstop_file, days=3, T_init=None,
backstop_file : string
The path to the backstop file.
days : float
The number of days to go back from the first command in the
backstop file to get the initial state. Default: 3
T_init : float, optional
The initial temperature for the thermal model run. If None,
an initial temperature will be determined from telemetry.
Default: None
other_cmds : list of commands or CommandTable
Other commands to be included in the list.
Notes
-----
All other keyword arguments which are passed to the main
:class:`~acispy.thermal_models.ThermalModelRunner`
constructor can be passed to this method as well.
Expand Down Expand Up @@ -1060,6 +1068,8 @@ class SimulateECSRun(ThermalModelRunner):
"""
Class for simulating thermal models for ECS measurements.
Parameters
----------
name : string
The msid of the model to simulate.
tstart : string or float
Expand All @@ -1071,9 +1081,9 @@ class SimulateECSRun(ThermalModelRunner):
attitude : array_like
The input attitude for this simulated ECS run. Can be one of three
types:
* (pitch, roll) combination, e.g. (155.0, 5.0)
* Attitude quaternion, e.g [1.0, 0.0, 0.0, 0.0]
* "vehicle" to use the vehicle load attitudes for the run.
* (pitch, roll) combination, e.g. (155.0, 5.0)
* Attitude quaternion, e.g [1.0, 0.0, 0.0, 0.0]
* "vehicle" to use the vehicle load attitudes for the run.
If the (pitch, roll) combination is chosen, note that a default
quaternion of [1.0, 0.0, 0.0, 0.0] will be used, which means that the
focal plane prediction may be inaccurate since the earth solid angle
Expand Down
2 changes: 1 addition & 1 deletion doc/source/loading_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ type of data desired and its name, for example:
ds["model", "1deamzt"] # gives you the "1deamzt" model component
A ``(type, name)`` pairing and its associated data are referred to as a "field". We'll
encounter examples of :ref:`derived-fields` later, which are derivations of new fields from
encounter examples of :ref:`Derived_Fields` later, which are derivations of new fields from
existing ones.

It is not strictly necessary to specify the ``(type, name)`` tuple if the ``name`` is
Expand Down
2 changes: 1 addition & 1 deletion doc/source/what_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ or the `MIT tools <http://cxc.cfa.harvard.edu/acis/memos/Dump_Psci.html>`_.

This page gives a broad outline of what ACIS-related data ACISpy can work with. To learn
the specific ways of loading and plotting the data, consult :ref:`loading-data` and
:ref:`plotting-data`.
:ref:`Plotting_Data`.

Commanded States
----------------
Expand Down

0 comments on commit 7d548bb

Please sign in to comment.