Galax Feature Parity

[nstarman]

.coordinates

• [x] cartesian_to_poincare_polar (https://github.com/GalacticDynamics/coordinax/pull/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

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

• [ ] DOPRI853Integrator
• [ ] LeapfrogIntegrator
• [ ] RK5Integrator
• [ ] Ruth4Integrator

.potential

Gravitational Potentials

• [x] base class
• [x] composite classes

Specific Gravitational Potentials:

• [x] BovyMWPotential2014
• [x] BurkertPotential (See https://github.com/GalacticDynamics/galax/pull/317)
• [ ] CylSplinePotential
• [ ] HarmonicOscillatorPotential
• [ ] HenonHeilesPotentia
• [x] HernquistPotential
• [x] IsochronePotential
• [x] JaffePotential
• [x] KeplerPotential
• [x] KuzminPotential
• [x] LM10Potential
• [x] LeeSutoTriaxialNFWPotential
• [x] LogarithmicPotential -> LMJ09LogarithmicPotential
• [x] LongMuraliBarPotential
• [ ] MN3ExponentialDiskPotential
• [x] MilkyWayPotential
• [ ] MilkyWayPotential2022
• [x] MiyamotoNagaiPotential
• [x] MultipolePotential (#357)
• [x] NFWPotential
• [x] NullPotential
• [x] PlummerPotential
• [x] PowerLawCutoffPotential
• [x] SatohPotential
• [x] StonePotential -> StoneOstriker15Potential
• [ ] SCFPotential

Methods on Potentials:

• [x] acceleration
• [ ] as_interop (implement as connection to existing I/O)
  • [x] gala (#375)
  • [x] galpy (#383)
  • [ ] agama
• [ ] circular_velocity (this will be a separate function since it assumes incorrect things about potentials)
• [x] density
• [x] energy (done as potential_energy)
• [x] gradient
• [x] hessian
• [x] integrate_orbit (done as evaluate_orbit)
• [ ] mass_enclosed (this will be a separate function since it assumes incorrect things about potentials)
• [ ] plotting (#97)
  • [ ] plot_contours
  • [ ] plot_density_contours
  • [ ] plot_rotation_curve
• [x] 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
• [x] total_energy
• [x] value (done as potential_energy and __call__)

Helper Functions:

• [ ] from_equation
• [ ] save / load

Reference Frames

• [ ] StaticFrame
• [ ] ConstantRotatingFrame

.dynamics

• [x] PhaseSpacePosition (in galax.coordinates)
• [x] Orbit
• [x] NDCartesianRepresentation (See https://github.com/GalacticDynamics/coordinax/pull/102)
• [x] NDCartesianDifferential (See https://github.com/GalacticDynamics/coordinax/pull/102)
• [ ] Action angle stuff (can't find a full API list)
• [x] BaseStreamDF
• [x] FardalStreamDF
• [ ] LagrangeCloudStreamDF
• [x] MockStream
• [x] MockStreamGenerator
  • [ ] stream arm selection https://github.com/GalacticDynamics/galax/issues/103
• [ ] StreaklineStreamDF
• [ ] fast_lyapunov_max
• [ ] lyapunov_max
• [ ] surface_of_section
• [ ] DirectNBody

.units

• [x] 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.