Metadata-Version: 2.1
Name: pyridoxine
Version: 0.3.1
Summary: A handy package for analyzing simulation data (VTK/LIS) produced by ATHENA (C version)
Home-page: https://github.com/astroboylrx/Pyridoxine/tree/Athena
Author: Rixin Li
Author-email: rixinli.astro@gmail.com
License: GPLv3+
Keywords: data analyzing snippets for Athena
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: astropy
Requires-Dist: shapely
Provides-Extra: dev
Requires-Dist: check-manifest ; extra == 'dev'
Provides-Extra: test
Requires-Dist: coverage ; extra == 'test'

[![PyPI version](https://badge.fury.io/py/pyridoxine.svg)](https://badge.fury.io/py/pyridoxine)  [![Anaconda version](
https://anaconda.org/astroboylrx/pyridoxine/badges/version.svg)](
https://anaconda.org/astroboylrx/pyridoxine)

# Pyridoxine: Handy Python Snippets for Athena Data

This branch contains useful Python snippets for analyzing simulation data produced by code [Athena](https://github.com/PrincetonUniversity/Athena-Cversion).

`Pyridoxine` is able to read `vtk` and `lis` files efficiently and the users can then post-process these data.  [This Jupyter Notebook](https://gist.github.com/astroboylrx/332611f562e4817c011800353ddb5a21) gives a simple demo.

## Installation

You may install `Pyridoxine` by this command:

```bash
pip install -U pyridoxine
```

Or, you may try the most updated `Pyridoxine` by this command:

```bash
pip install -U -e git+git://github.com/astroboylrx/Pyridoxine@Athena#egg=Pyridoxine
```

It will automatically install all the required modules. Note that `#egg=Pyridoxine` is not a comment here. It is to explicitly state the package name.
