Feature request: Document the cosmology module

SWIFTSIM / swiftsimio

Python library for reading SWIFT data. Uses unyt and h5py.

GNU Lesser General Public License v3.0

18 stars 13 forks source link

Feature request: Document the cosmology module #106

Open MatthieuSchaller opened 3 years ago

MatthieuSchaller commented 3 years ago

Following questions from users it would be good to say a few words in the documentation about the way swiftsimio extracts the cosmo info from a snapshot and turns it into a astropy.cosmology blob.

bwvdnbro commented 2 years ago

The documentation for the metadata already contains the following:

If you have astropy installed, you can also use the metadata.cosmology object, which is an astropy.cosmology.w0waCDM instance.

Is that not sufficient?