Metadata-Version: 2.1
Name: yt_aspect
Version: 0.2.1
Summary: A yt plugin for loading ASPECT output
Author-email: Chris Havlin <chris.havlin@gmail.com>
Project-URL: Homepage, https://github.com/data-exp-lab/yt_aspect
Project-URL: Bug Tracker, https://github.com/data-exp-lab/yt_aspect/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: yt>=4.2.2
Requires-Dist: xmltodict
Provides-Extra: test
Requires-Dist: pytest>=6.1; extra == "test"
Requires-Dist: tomli; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: dev
Requires-Dist: pre-commit; extra == "dev"

# yt_aspect

This package is a plugin for [yt](https://yt-project.org) that adds a frontend for [ASPECT](https://aspect.geodynamics.org/) unstructured mesh output in .pvtu format. It also includes a general .pvtu frontend. 

## Installation

Use pip to install:

```
pip install yt-aspect
```

To install a development version,  clone this repository, `cd` into the clone and then install locally with

```
pip install -e .
```

A number of dependencies will be installed for you, including `yt` if you don't already have it. 

## Usage

To load a single timestep:

```python
import yt

ds = yt.load('output_convection_box_3d/solution/solution-00000.pvtu')
```

From there, you can work with the dataset as a normal yt dataset (though not all functionality will work -- open an issue [here](https://github.com/data-exp-lab/yt_aspect/issues) if something you need doesn't work!). Until there are ASPECT specific examples in this repository, check out the [main yt documentation](https://yt-project.org/doc/) for examples.

## Bugs and Requests
This is still in an experimental stage, so you will likely find bugs and missing features! Feel free to [open an issue](https://github.com/data-exp-lab/yt_aspect/issues), contact us via [slack](https://yt-project.slack.com/) or submit pull requests.
