Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

documentation changes #61

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

FDauphin
Copy link

Apologies if I'm not using standard SWE vocabulary or mixing up words where necessary...

Major changes:

  • all help files are removed
  • all modules have combined content from help files, wfc3tools readthedocs, and WFC3 DHB as documentation
  • documentation cross references WFC3 DHB where applicable
  • Pyraf support in documentation removed
  • stsci.tools.teal support removed
  • Python 2 dependencies (e.g. from future import division) removed
  • readthedocs and module documentation are consistent with each other
  • README on main page edited
  • wfc3tools/test moved out of main package and into main repo
  • removed wfc3tools/pars (can easily put it back if necessary)
  • added scripting functionality to most py files (i.e. if name = 'main':)

Not sure of:

  • calwf3 doc file is too advanced; need someone with more experience to make sure it is consistent with actual calibration routine
  • some functionality questions in py files that need to be answered (e.g. do we need some parameters if they aren't being called in the Python wrapper?)

We need to add on main README the necessary details that wfc3tools is a Python wrapper and you need(?) hstcal already installed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant