search

feder-observatory / stellarphot

Stellar aperture photometry
https://stellarphot.readthedocs.io
BSD 3-Clause "New" or "Revised" License
4 stars 12 forks source link

Update docs #386

Closed mwcraig closed 1 month ago

mwcraig commented 1 month ago

This PR will provide a set of adequate documentation for a 2.0 alpha release.

mwcraig commented 1 month ago

@JuanCab -- please ignore this for now

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 52.09%. Comparing base (65f4e5b) to head (0779673). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #386 +/- ## ========================================== - Coverage 52.12% 52.09% -0.03% ========================================== Files 56 56 Lines 5815 5812 -3 ========================================== - Hits 3031 3028 -3 Misses 2784 2784 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

mwcraig commented 1 month ago

@JuanCab @Tanner728 -- please take a look at this when you can.

Start with the instructions at https://stellarphot--386.org.readthedocs.build/386/ and try opening the 4 notebooks it mentions. You will need to get a FITS image from somewhere.

One known issue, reported at https://github.com/trungleduc/jupyter_app_launcher/issues/66, is that the second and later notebooks you open and run may give you weird errors. If so, close the notebook and reopen it by double clicking in the file browser.

mwcraig commented 1 month ago

@Tanner728 @JuanCab -- thanks for the feedback. I think a few of the items need to wait until after 2.0 is out but have noted where I opened issues for those.

Please give this another quick look as soon as you are able.

mwcraig commented 1 month ago

Thanks, merging -- @Tanner728, I'll have updated instructions for testing a little later today