jwst icon indicating copy to clipboard operation
jwst copied to clipboard

DOC: Add quick start

Open pllim opened this issue 4 years ago • 3 comments

Description

This PR adds a quick start section for lazy people like me. Would have helped when I don't care about running the pipeline but just wants to know quickly how to read your product.

Checklist

  • [x] Tests -- N/A
  • [x] Documentation
  • [x] Change log -- N/A
  • [ ] Milestone -- I cannot add this, so you have to
  • [ ] Label(s) -- I cannot add this, so you have to. Do you know that Action can auto-add labels?

pllim avatar Apr 21 '21 16:04 pllim

Example to load both to astropy.nddata.CCDData is even better, but when I tried with astropy 4.3.dev, CCDData does not understand GWCS; alas!

pllim avatar Apr 21 '21 16:04 pllim

Codecov Report

Merging #5976 (c024f49) into master (d26b6f0) will not change coverage. The diff coverage is n/a.

:exclamation: Current head c024f49 differs from pull request most recent head 627be55. Consider uploading reports for the commit 627be55 to get more accurate results Impacted file tree graph

@@           Coverage Diff           @@
##           master    #5976   +/-   ##
=======================================
  Coverage   77.77%   77.77%           
=======================================
  Files         404      404           
  Lines       35367    35367           
=======================================
  Hits        27505    27505           
  Misses       7862     7862           
Flag Coverage Δ *Carryforward flag
nightly 77.77% <ø> (ø) Carriedforward from d26b6f0
unit 56.20% <ø> (ø)

*This pull request uses carry forward flags. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update d26b6f0...627be55. Read the comment docs.

codecov[bot] avatar Apr 21 '21 17:04 codecov[bot]

Rendered doc: https://jwst-pipeline--5976.org.readthedocs.build/en/5976/jwst/data_products/quickstart.html

pllim avatar Apr 21 '21 18:04 pllim

I am going to close this one because the documentation has been reworked.

nden avatar Dec 19 '22 16:12 nden