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 improvements - Tutorials! #22

Merged
merged 7 commits into from
May 17, 2024
Merged

Documentation improvements - Tutorials! #22

merged 7 commits into from
May 17, 2024

Conversation

dahlend
Copy link
Collaborator

@dahlend dahlend commented May 17, 2024

This moves documentation around a bit, the doc folder was renamed docs to be more inline with standards.

Added

  • Added 'Tutorials' to the documentation, these are larger worked examples which do not
    build at the same time as the standard docs. They are designed to be examples which
    take significant compute, and may run for many minutes.
  • Added Tutorials for 'KONA' and 'WISE Precovery'.

Changed

  • FOV propagation tests now return a flatten list of states.

Fixed

  • Coordinate frame conversion was resulting in incorrect coordinate positions when
    passing Equatorial based frames to some FOV related functions. Specifically it was
    failing to convert the Equatorial frame to Ecliptic frame before performing orbit
    calculations.

@dahlend
Copy link
Collaborator Author

dahlend commented May 17, 2024

image
image

@dahlend dahlend merged commit 0d75f53 into main May 17, 2024
1 check passed
@dahlend dahlend deleted the move_docs branch May 17, 2024 20:25
dahlend added a commit that referenced this pull request May 20, 2024
* Release v0.2.1 (#17)

release v0.2.1

* Remove NEO population model (#18)

* remove neo construction

* black update

* Fix doc construction (#19)

* Removed unused PDS tools (#20)

Remove unused PDS tools

* Add support for downloading ZTF fov information (#21)

* Add support for downloading ZTF fov information

* changelog

* mypy

* comments on how FOVs are made

* consistency

* docs

* add simple MPC code lookup to spice

* mypy

* fix docs and add caching

* Documentation improvements - Tutorials! (#22)

* rename doc to docs

* Frame conversion was inconsistent before FOV check

* fix FOV checks and add tutorials

* tutorials

* remove match so that black works easily

* compress fits file

* order of construction is important.

* typo in docs

* Bring API docs up to date (#23)

* fix API docs

* Minor Typos in docs (#24)

* Release version 0.2.2 (#25)

* update github build
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