Release Version - v0.2.4

dahlend commented 4 months ago

Overall changes for this release can be broadly categorized into these groups:

Cleanup and removal of unnecessary python code and documentation.
Rewrite of how spice kernels are managed with the future goal of making neospy able to write to them.
Wrote a time conversion implementation based upon the international standard algorithms for time conversion available from the organization which coordinates time. This led to a 3-400x speedup over the astropy implementation.
Orbit calculations received a performance tune-up, and accuracy improvements.

[0.2.4] - 2024 - 7 - 15

Added

Add J2 non-spherical terms for the gravitational models of Earth and Jupiter.
Add non-gravitational force model for dust particles which includes the Poynting-Roberterson effect.
Added Time.year_float which converts the Time object to the Year as a float.
Added SimultaneousState.obs_vecs which creates vectors from the observer to the objects contained within the state.
Added NEATM tutorial which gives an overview of NEATM along with a small example.

Changed

Optimized SPICE kernel loading for Type 2 records, which is what DE440 is saved as. This means effectively all n-body propagation is now 15-20% faster than before.
Removed SpiceKernel as a class, lowering all its methods to the submodule level, see #68 for more discussion.
Removed Time object which was a wrapper over astropy.Time, instead making a custom implementation of time which is ~3-400x faster than previous.
Improved orbital element conversion, leading to a 2-3x speedup in two body orbit propagation.
Significant rewrite of the SPICE kernel file management, this rewrite is required so that future work can enable writing SPICE kernel files.
Moved the downloading of Horizons spice kernels from SpiceKernel to horizons.
Renamed all field of view checking functions to similar names: fov_static_check, fov_state_check, and fov_spice_check. These functions are exposed at the base level of neospy.
Moved much of the python documentation into the rust wrappers, and removed the remaining empty python files. Part of the rewrite involved moving and renaming many functions.
Updated nalgebra to minimum version ^0.33.0, which uses a simplified allocator.
Fixed minimum versions for all rust libraries.

Fixed

Orbital Elements now correctly computes true_anomaly, mean_anomaly, eccentric_anomaly, semi_major_axis, and mean_motion for parabolic and hyperbolic orbits.
Two body propagation for parabolic orbits was incorrect.
Typo in Observability example was leading to an incorrect Magnitude value.
Astropy WCS warnings are now suppressed.
SpiceKernels.moon_illuminated_frac now agrees with JPL Horizons, this was doing a geometric calculation which was correct, but with a different interpretation than desired.

Removed

Removed support for SPK Files of type 3, these should be a trivial change from type 2 however I do not have access to a file of type 3 for testing. Because it cannot be validated at the moment, the code has been removed.

fmasci commented 4 months ago

Are non-spherical perturbations from the Sun included too (implicitly)?

https://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1981ApJ...246..985U&defaultprint=YES&filetype=.pdf [preview.png] nph-iarticle_queryhttps://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1981ApJ...246..985U&defaultprint=YES&filetype=.pdf PDF Document · 331 KBhttps://articles.adsabs.harvard.edu/cgi-bin/nph-iarticle_query?1981ApJ...246..985U&defaultprint=YES&filetype=.pdf

Regards, Frank

On Jul 15, 2024, at 8:31 AM, Dar Dahlen @.***> wrote:

[0.2.4] - 2024 - 7 - 15 Added

Add J2 non-spherical terms for the gravitational models of Earth and Jupiter.
Add non-gravitational force model for dust particles which includes the Poynting-Roberterson effect.
Added Time.year_float which converts the Time object to the Year as a float.
Added SimultaneousState.obs_vecs which creates vectors from the observer to the objects contained within the state.
Added NEATM tutorial which gives an overview of NEATM along with a small example.

Changed

Optimized SPICE kernel loading for Type 2 records, which is what DE440 is saved as. This means effectively all n-body propagation is now 15-20% faster than before.
Removed SpiceKernel as a class, lowering all its methods to the submodule level, see #68https://github.com/IPAC-SW/neospy/issues/68 for more discussion.
Removed Time object which was a wrapper over astropy.Time, instead making a custom implementation of time which is ~3-400x faster than previous.
Improved orbital element conversion, leading to a 2-3x speedup in two body orbit propagation.
Significant rewrite of the SPICE kernel file management, this rewrite is required so that future work can enable writing SPICE kernel files.
Moved the downloading of Horizons spice kernels from SpiceKernel to horizons.
Renamed all field of view checking functions to similar names: fov_static_check, fov_state_check, and fov_spice_check. These functions are exposed at the base level of neospy.
Moved much of the python documentation into the rust wrappers, and removed the remaining empty python files. Part of the rewrite involved moving and renaming many functions.
Updated nalgebra to minimum version ^0.33.0, which uses a simplified allocator.
Fixed minimum versions for all rust libraries.

Fixed

Orbital Elements now correctly computes true_anomaly, mean_anomaly, eccentric_anomaly, semi_major_axis, and mean_motion for parabolic and hyperbolic orbits.
Two body propagation for parabolic orbits was incorrect.
Typo in Observability example was leading to an incorrect Magnitude value.
Astropy WCS warnings are now suppressed.
SpiceKernels.moon_illuminated_frac now agrees with JPL Horizons, this was doing a geometric calculation which was correct, but with a different interpretation than desired.

Removed

Removed support for SPK Files of type 3, these should be a trivial change from type 2 however I do not have access to a file of type 3 for testing. Because it cannot be validated at the moment, the code has been removed.

You can view, comment on, or merge this pull request online at:

https://github.com/IPAC-SW/neospy/pull/76

Commit Summary

1426aadhttps://github.com/IPAC-SW/neospy/pull/76/commits/1426aadbc77334381b6c631a2c5da782ed2436be Update version - v0.2.4
1e7084dhttps://github.com/IPAC-SW/neospy/pull/76/commits/1e7084d1466fe6aca6215561f98196d2b205e285 change spice.state to spice.get_state for clarity

File Changes

(19 fileshttps://github.com/IPAC-SW/neospy/pull/76/files)

M CHANGELOG.mdhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4ed (3)
M Cargo.tomlhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-2e9d962a08321605940b5a657135052fbcef87b5e360662bb527c96d9a615542 (2)
M docs/tutorials/propagation_plots.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-dbf4c5f48a943a1c9ab6912d19b339a2251568e2341a6a6017a6dda795d4de1e (6)
M pyproject.tomlhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711 (2)
M src/examples/galactic_center.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-d5f93620537d759ff958a6cb7fbe59ec9e195e2df1bdee0325af346487885840 (2)
M src/examples/plot_close_approach.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-326f6b6824b89165f63c985a338387dadd4fb8ace5a0f49c483fdf62aba38589 (2)
M src/examples/plot_close_encounter.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-75fe4942e819173dd23b472e7d3b0aef65f7e36e7788366b2f04afba53d9012f (6)
M src/examples/plot_light_curve.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-0d47aec5d0124fb9480c41598400b2ae0b1843e62c5bc18b56f5d3b13d1853c0 (4)
M src/examples/plot_mpc_state.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-336e4303f71f865362247dbbc2ed64a61efbd4dfdff20c6615b0b00a6f8e6bdd (4)
M src/examples/plot_phases.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-5f44e293fa5c5759cfb80903121fe171c8ca63c90410bcc2d8d119e3fa7fa09a (2)
M src/examples/plot_trojans.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-65f36e3d3be6d2c4dd23c626dfc6de0eacc0e4667e72b0f716af6e367a0c45d4 (2)
M src/examples/plot_uncertainty.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-8399158a843c08e0732d60fcf5fb3e97111c4e2421005171d99d93c4fd94f125 (4)
M src/neospy/mpc.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-bcfd011be96c2d09354f38b75bb9ff8934e353b8954e93f31e9713061017051f (2)
M src/neospy/propagation.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-45683271e59f4112916f47aa8fa36bc09f4053de63a4d6a3405f06d432f39ed4 (2)
M src/neospy/spice.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-79948eeb44eb5ddcdad7f426acd32399b9b4dce3fa9e0d20990c6d5199110e05 (8)
M src/neospy/wise.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-076baf9ed04625c6074a59f212db955d4e9f378e1ffdc20e519e8640a9ce0db0 (2)
M src/neospy_core/Cargo.tomlhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-035d64201bc3ff6b966ba5f66bc275c6556bd415ee7a9225fc273a33ff5df058 (2)
M src/tests/test_propagation.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-45bf52642a851e2f68b4a0155f06598367a4f72b88aca22ff071e8bcfd785b23 (10)
M src/tests/test_spice.pyhttps://github.com/IPAC-SW/neospy/pull/76/files#diff-ee26ebc8ae8d6122e0f030b3fb8b5b28f3f8188f260695e0a25be53c9861ce21 (4)

Patch Links:

— Reply to this email directly, view it on GitHubhttps://github.com/IPAC-SW/neospy/pull/76, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ADXUBIKYK76GNNXCKU5GNM3ZMPTOVAVCNFSM6AAAAABK4ZGNAKVHI2DSMVQWIX3LMV43ASLTON2WKOZSGQYDSMBTGM2TSNQ. You are receiving this because you are subscribed to this thread.Message ID: @.***>

dahlend commented 4 months ago

Yes, J2 was added in the past release, currently the code does J2 for Jupiter, Earth, the Sun. General Relativistic corrections for the Sun and Jupiter, and optional inclusion of the 5 most massive asteroids in the main belt. Comets and Dust which undergo non-gravitational forces now have almost exactly matching support for what JPL Horizons has, I have neglected one of their terms due to its very infrequent use.

Caltech-IPAC / kete