search

grackle-project / grackle

The Grackle chemistry and cooling library for astrophysical simulations and models.
Other
26 stars 50 forks source link

Pygrackle documentation #214

Open brittonsmith opened 5 months ago

brittonsmith commented 5 months ago

Pygrackle currently has very little in terms of narrative or API documentation apart from the example Python scripts. Documentation should include:

  1. FluidContainer
  2. Convenience functions
  3. Evolve functions
  4. Grackle-yt interface (specifically how to do for non-Enzo codes)
  5. API reference section for all functions