Galax Feature Parity

[nstarman]

.coordinates

• cartesian_to_poincare_polar (Polar Poincare Vector coordinax#136)
• make_greatcircle_cls (will be done in coordinax)
• pole_from_endpoints (will be done in coordinax)
• reflex_correct
• transform_pm_cov (will be done in coordinax)
• vgsr_to_vhel
• vhel_to_vgsr

Coordinate Frames:

• Frame Classes require the Operator framework to be worked on further!

.integrate

• parse_time_specification (feat: parse_time_specification #395)

Only need the Diffrax integrator. It would be good to add the others, for reproducibility.

• DOPRI853Integrator
• LeapfrogIntegrator
• RK5Integrator
• Ruth4Integrator

.potential

Gravitational Potentials

• base class
• composite classes

Specific Gravitational Potentials:

• BovyMWPotential2014
• BurkertPotential (See feat: BurkertPotential #317)
• CylSplinePotential
• HarmonicOscillatorPotential (feat: HarmonicOscillatorPotential #262)
• HenonHeilesPotential (feat: HenonHeilesPotential #471)
• HernquistPotential
• IsochronePotential
• JaffePotential
• KeplerPotential
• KuzminPotential
• LM10Potential
• LeeSutoTriaxialNFWPotential
• LogarithmicPotential -> LMJ09LogarithmicPotential
• LongMuraliBarPotential
• MN3ExponentialDiskPotential (feat: MN3 and MilkyWayPotential2022 #418)
• MilkyWayPotential
• MilkyWayPotential2022 (feat: MN3 and MilkyWayPotential2022 #418)
• MiyamotoNagaiPotential
• MultipolePotential (feat: multipole potentials #357)
• NFWPotential
• NullPotential
• PlummerPotential
• PowerLawCutoffPotential
• SatohPotential
• StonePotential -> StoneOstriker15Potential
• SCFPotential ([WIP] SCF Potential #9)

Methods on Potentials:

• acceleration
• as_interop (implement as connection to existing I/O)
  • gala (feat: Galax to Gala io #375)
  • galpy (feat: I/O galpy <-> galax #383)
  • agama
• circular_velocity (feat: circular velocity #417)
• density
• energy (done as potential_energy)
• gradient
• hessian
• integrate_orbit (done as evaluate_orbit)
• mass_enclosed (this will be a separate function since it assumes incorrect things about potentials)
• plotting (feat: plotting #97)
  • plot_contours
  • plot_density_contours
  • plot_rotation_curve
• replicate (use dataclasses.replace)
• replace_units (IDK if this will be supported as it's used in gala for internally stripping units, which galax doesn't need to do)
• save
• to_latex
• to_sympy
• total_energy
• value (done as potential_energy and __call__)

Helper Functions:

• from_equation
• save / load

Reference Frames

• StaticFrame
• ConstantRotatingFrame

.dynamics

• PhaseSpacePosition (in galax.coordinates)
• Orbit
  • .projection
• NDCartesianRepresentation (See feat: NDCartesian coordinax#102)
• NDCartesianDifferential (See feat: NDCartesian coordinax#102)
• Action angle stuff (can't find a full API list)
• BaseStreamDF
• FardalStreamDF
• LagrangeCloudStreamDF
• MockStream
• MockStreamGenerator
  • stream arm selection Allow for lead, trail in stream #103
• StreaklineStreamDF
• fast_lyapunov_max
• lyapunov_max
• surface_of_section
• DirectNBody (feat: direct n-body #419)

.units

• Everything. See unxt package.

[nstarman]

@adrn @jnibauer What do you think should be our v0.1 goals? I think all the potentials (and methods like circular velocity) + StreamDFs + reflex_correct. We are relatively close. We also need to standardize the parameter names and smooth the time API.

[adrn]

I think potentials, circular_velocity/mass_enclosed, streams, and documentation/tutorials!

[nstarman]

IMO We should also add back in some methods, like integrate_orbit, but @deprecated so that users can seamlessly transition their code from gala to galax, then update to the new (and not deprecated) API.
E.g. #419 andMockstreamGenerator, but which point users to #193.