Skip to content

Commit

Permalink
Minor Typos in docs (#24)
Browse files Browse the repository at this point in the history
  • Loading branch information
dahlend authored May 17, 2024
1 parent 5f9d2f2 commit a76ad87
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 13 deletions.
12 changes: 6 additions & 6 deletions docs/background.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ There are several common definitions of coordinate frames in astronomy, here are
listed in order of general popularity:

- **Equatorial** - The X-Y plane is defined by the celestial equator (Earth's
Equator). The x-axis is defined pointing to the Vernal Equinox (IE: where the
Sun crosses the equator in the northward direction).
Equator). The x-axis is defined pointing to the Vernal Equinox (IE: where the
Sun crosses the equator in the northward direction).
- **Ecliptic** - The X-Y plane is defined by the plane of the Earth around the Sun,
where the x-axis is defined as the same vector as the Equatorial frame. This in
essence means that conversion between the two is a rotation around the x-axis by
some angle (more on that later).
where the x-axis is defined as the same vector as the Equatorial frame. This in
essence means that conversion between the two is a rotation around the x-axis by
some angle (more on that later).
- **Galactic** - The X-Y plane is defined to be the galactic plane, there is a
non-trivial conversion and definition for this frame.
non-trivial conversion and definition for this frame.

At first glance these definitions appear relatively precise, however they are not. The
issue is with the definition of the Vernal Equinox. As the Earth orbits the sun, its
Expand Down
8 changes: 2 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,11 @@ surveys of minor planets. Included here are:

- Orbit propagation code capable of accurately calculating the orbits for many
thousands of minor planets over decades on a laptop.
- Thermal modeling, including NEATM (Near Earth Asteroid Thermal Model) and the FRM (
Fast Rotator Model) for asteroids. Including support for non-spherical asteroids.
- Thermal modeling, including NEATM (Near Earth Asteroid Thermal Model) and the FRM
(Fast Rotator Model) for asteroids. Including support for non-spherical asteroids.
- Optical modeling.
- Statistical models of NEA and MBA asteroid populations, which enable the generation
of realistic synthetic populations.
- Interfaces to IPAC's IRSA, JPL's Horizons, and the Minor Planet Centers web tools.
- Multi-core support for reading SPICE SPK files (SPICE itself is not used).
- A model of ground based observatory performance based upon historical asteroid
detections.
- Geometric calculations to check if an object is visible from an observer's
position.

Expand Down
2 changes: 1 addition & 1 deletion src/neospy/rust/state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ impl PyState {

/// Change the center ID of the state from the current state to the target state.
///
/// If the desired state is not a known NAID id this will raise an exception.
/// If the desired state is not a known NAIF id this will raise an exception.
pub fn change_center(&self, naif_id: isize) -> PyResult<Self> {
let mut state = self.0.clone();
let spk = neospy_core::prelude::get_spk_singleton()
Expand Down

0 comments on commit a76ad87

Please sign in to comment.