Metadata-Version: 2.1
Name: pyxshells
Version: 2.8
Summary: python tools for handling field output of xshells code
Home-page: https://nschaeff.bitbucket.io/xshells
Author: Nathanael Schaeffer
Author-email: Nathanael Schaeffer <nathanael.schaeffer@gmail.com>
Project-URL: Homepage, https://nschaeff.bitbucket.io/xshells
Project-URL: Documentation, https://nschaeff.bitbucket.io/xshells/manual.html
Project-URL: Repository, https://bitbucket.org/nschaeff/xshells/
Project-URL: Changelog, https://bitbucket.org/nschaeff/xshells/src/master/CHANGELOG.md
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: CEA CNRS Inria Logiciel Libre License, version 2.1 (CeCILL-2.1)
Classifier: Intended Audience :: Science/Research
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Scientific/Engineering
Requires: numpy
Requires: matplotlib
Requires: shtns
Requires-Python: >=3.2
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: shtns

**Python modules and programs to handle outputs of the xshells code.**

# xsplot

xsplot is a python module and also a command line utility that can display:

- time evolution of quantities stored in the `energy.*` files,
- slices and spectra produced by the `xspp` program from simulation fields.

For instance, from command line:

    python -m xsplot energy.bench -c Eu   # displays kinetic energy ('Eu') as a function of time
    
The same things within a python script or notebook:

    import matplotlib.pyplot as plt
    import xsplot
    y = xsplot.load_diags('energy.bench')
    plt.plot(y['t'],y['Eu'])

# pyxshells

pyxshells is a python module to work with `field*` files from simulations.
For instance:

     import pyxshells
     f = pyxshells.load_field('fieldU.bench')
     kinetic_energy = f.energy()
     print(kinetic_energy)

# DOCUMENTATION
For more info, see <https://nschaeff.bitbucket.io/xshells/Ch3.html>
