[WIP] Update documentation to reflect API changes #489
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for fiberassign, most notably the "usage" page that defines a minimal example of how the package should be used and run, refer to API elements that are significantly out of date. In some cases the example refers to scripts that don't exist anymore or have been renamed. This PR aims to update these instances where noted to bring the documentation inline with the most recent version of fiberassign. Major changes documented here:
fba_run
The command line arguments of
fba_runhave changed significantly since the last documentation update. Notably the following two arguments have been removed:--positioners--statusThe following arguments were added:
--ha--fieldrot--fieldrot_corr--sky_per_slitblock--margin-pos--margin-petal--margin-gfa--gaia_stdmask--by-tile--no-redistribute--lookup_sky_source--fafns_for_stucksky--fba_use_fabsfba_plot
fba_plot_resultswas at some point renamedfba_plot, but this was not documented in the documentation. All instaces offba_plot_resultshave been updated to now correctly refer tofba_plot. Usage of the script has also changed, instead of giving it a file of tiles to plotfba_plotreads everything necessary from the associated fiber assignment file produced byfba_run. The Usage page has been updated to reflect this fact.This PR is still a WIP, additional documentation updates are expected in the near future.