Skip to content

Commit

Permalink
update argument documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
stscieisenhamer committed Oct 23, 2023
1 parent 3471ee1 commit 50eddf1
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/roman/ramp_fitting/arguments.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
Arguments
=========
The ramp fitting step has three optional arguments that can be set by the user:
The ramp fitting step has the following optional argument that can be set by the user:

* ``--algorithm``: Algorithm to use. Possible values are `ols` and `ols_cas22`.
`ols` is the same algorithm used by JWST and can only be used with even ramps.
`ols_cas22` needs to be used for uneven ramps. `ols_cas22` is the default.

The following optional arguments are valid only if using the `ols` algorithm.

* ``--save_opt``: A True/False value that specifies whether to write
the optional output product. Default if False.
Expand Down

0 comments on commit 50eddf1

Please sign in to comment.