Metadata-Version: 2.3
Name: kgsim
Version: 0.2.12
Summary: A library to interact with simulations with.
Author: Keyan Gootkin
Author-email: Keyan Gootkin <keyangootkin@gmail.com>
Requires-Dist: h5py>=3.15.1
Requires-Dist: kbasic>=0.1.2
Requires-Dist: kplot>=1.1.3
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: numpy>=2.4.2
Requires-Dist: pytest>=9.0.2
Requires-Dist: pytest-cov>=7.0.0
Requires-Dist: scipy>=1.17.0
Requires-Dist: tqdm>=4.67.3
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# PySim
PySim is a package for simply interacting with simulations in a pythonic, object oriented way.

```python
from pysim.dhybridr.turbulence import TurbSim

s = TurbSim("path/to/simulation")
# examine initial conditions
s.B.z.show(0)
s.u.x.show(0)
# make video of density evolution over simulation
from kplot import show_video
@show_video(name='energy_flux', latex=r'$\rho \mathcal{u}_\perp^2$')
def energy_flux(s, **kwargs) -> np.ndarray:
    return np.array([p*(ux**2+uy**2) for p, ux, uy in zip(s.density, s.u.x, s.u.y)])

energy_flux(s)
```

