temet toolkit: documentation

Welcome to the documentation for temet (github repo), a python toolkit for the execution, analysis, and visualization of numerical simulations. Specifically, hydrodynamical simulations run with the AREPO moving mesh code, as well as codes producing similarly structured outputs including GADGET-4, GIZMO and SWIFT.

In addition, this codebase is focused on cosmological simulations for large-scale structure and galaxy formation, particularly those processed with a substructure identification algorithm (halo finder) such as subfind, including Illustris, IllustrisTNG, EAGLE, and so on. Generally speaking, any simulation data available from the TNG public data release platform can be directly analyzed with this toolkit.

_images/logo_lg.png

Caution

This documentation is a work in progress. Please report any issues or suggestions.

For that matter, the entire temet library is a work in progress.

It may not be the polished, well-documented, or fully-featured library you are expecting. Rather than being developed from scratch as a user-facing software package, it is the evolution of various personal research projects, with functionality slowly generalized and expanded over time. As a result, it will have many rough edges and incomplete features.

However, it is being actively developed and improved. You are welcome to play with it and see if it may be useful. Feedback is always welcome!

Citation and Acknowledgment

This code was originally written by Dylan Nelson (dnelson@uni-heidelberg.de).

If you find it useful and/or make use of it for a scientific publication, please cite Nelson, D. (in prep).

Index

To contribute to this documentation, update either in-code comments or supplementary files in the docs/ directory, then commit.