Skip to content

Commit

Permalink
Update metadata.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
lgarrison authored Oct 9, 2023
1 parent 209eb45 commit 0e0d82c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/metadata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ for Abacus simulations like AbacusSummit. One can use this module to
query information about simulations without actually downloading or
opening any simulation files.

The main entry point is the ``get_meta(simname, redshift=z)`` function.
If one does have simulation files, then it's recommended to just use those
instead of this module. The metadata from those files is usually loaded
and exposed to the user via the Python API; e.g. if using a CompaSO halo
catalog, one can use `cat.header` to access metadata.

The main entry point to this module is the ``get_meta(simname, redshift=z)`` function.
Examples and the API are below.

Examples
Expand Down

0 comments on commit 0e0d82c

Please sign in to comment.