Metadata-Version: 2.4
Name: vdfpy
Version: 0.1.2
Summary: Velocity distribution function classifier
Author-email: Hongyang Zhou <hyzhou@umich.edu>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: flekspy>=0.6.0
Requires-Dist: pyvlasiator>=0.1.4
Requires-Dist: scikit-learn>=1.5.2
Requires-Dist: scipy>=1.14.1
Requires-Dist: pandas>=2.2.3
Requires-Dist: pyspedas>=1.7.1
Requires-Dist: umap-learn>=0.5.7
Requires-Dist: yt<5,>=4.3.0
Provides-Extra: docs
Requires-Dist: myst-nb>=1.0.0; extra == "docs"
Requires-Dist: myst-parser>=2.0.0; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.15.0; extra == "docs"
Requires-Dist: seaborn>=0.13.2; extra == "docs"
Requires-Dist: sphinx-autoapi>=3.0.0; extra == "docs"
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: pytest-benchmark>=4.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
Requires-Dist: jupyter>=1.0.0; extra == "dev"
Requires-Dist: matplotlib>=3.7.2; extra == "dev"
Requires-Dist: vdfpy[docs]; extra == "dev"
Dynamic: license-file

# VDFPy

<p align="center">
  <a href="https://badge.fury.io/py/vdfpy">
    <img src="https://badge.fury.io/py/vdfpy.svg" alt="PyPI version" height="18">
  </a>
  <a href="https://github.com/henry2004y/vdfpy/actions">
    <img src="https://github.com/henry2004y/vdfpy/actions/workflows/CI.yml/badge.svg">
  </a>
  <a href="https://henry2004y.github.io/vdfpy/">
    <img src="https://img.shields.io/badge/docs-dev-blue">
  </a>
  <a href="LICENSE">
    <img src="https://img.shields.io/badge/license-MIT-blue">
  </a>
  <a href="https://app.codecov.io/gh/henry2004y/vdfpy/">
    <img src="https://img.shields.io/codecov/c/github/henry2004y/vdfpy">
  </a>
</p>

VDFPy is a velocity distribution function classifier in Python.

## Installation

```python
python -m pip install vdfpy
```

## Usage

We currently support extracting data from simulation (Vlasiator, FLEKS) and satellite observation (pyspedas).
Please refer to the [documentation](https://henry2004y.github.io/vdfpy/) for more details.

## License

`vdfpy` is licensed under the terms of the MIT license.
