libyt Documents

Version 0.1.0

libyt is an open source C library for simulation. It is an in situ analysis tool that allows researchers to analyze and visualize data using yt or other Python packages in parallel during simulation runtime.

Content

• How to Install: how to get libyt?
• How it Works: what is happening behind the scene?
• Example: this demonstrates how to implement libyt in simulation step by step.
• libyt API: this is for simulation developers that wish to implement libyt.
• In Situ Python Analysis: this is for users that are using libyt to do in situ analysis.
• Debug and Time Profiling: how to check inputs and run time profiling in libyt.

Label Meanings

• means be careful about the lifetime of this variable. libyt only borrows it, and does not make a copy.
• means more information on this topic.
• means things we should be careful.
• means things we are trying to improve.