Metadata-Version: 2.4
Name: pysplot
Version: 0.1.0
Summary: A spatial and temporal plotting package for heliophysics data
Home-page: https://github.com/pysplot/pysplot
Author: Brent Smith
Author-email: brent.smith@jhuapl.edu
Classifier: Programming Language :: Python :: 3
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: sunpy>=5.1.5
Requires-Dist: pandas>=2.2.3
Requires-Dist: matplotlib>=3.9.0
Provides-Extra: whpi
Requires-Dist: imageio>=2.9.0; extra == "whpi"
Provides-Extra: examples
Requires-Dist: cdasws>=1.7.42; extra == "examples"
Requires-Dist: cdflib>=0.4.9; extra == "examples"
Requires-Dist: xarray>=0.20.1; extra == "examples"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# `pysplot`: Spatiotemporal Plotting in Python

The `pysplot` package hosts tools and visualization methods for making spatial and temporal plots with heliophysics timeseries data.

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Installation

To install the package:
```
pip install pysplot
```
Install additional dependencies if running through the examples:
```
pip install pysplot[examples]
```
or using the WHPI-specific tools:
```
pip install pysplot[whpi]
```

## Usage

After installation, you can use the package as follows:

```python
from pysplot.io.data import SpatialData, ScienceData, SpatialTimeData
from pysplot.plots.plottypes import orbit_plot
import matplotlib.pyplot as plt

# input data as dictionaries
spatial_data_dictionary = {'x': [...], 'y': [...]}
science_data_dictionary = {'x': [...], 'y': [...]}

# Initiate data objects
spatial_data = SpatialData(spatial_data_dictionary)
science_data = ScienceData(science_data_dictionary)
combined_splot_data = SpatialTimeData(spatial_data, science=science_data)

# Make plots
fig, ax = plt.subplots()
orbit_plot(combined_splot_data.data, ax, 'x', 'y')
```

For a full example of how to use `pysplot`, refer to our example notebooks.


## Contributing

We welcome contributions to improve this package! To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Create a pull request.

Please make sure your code adheres to the existing style guidelines and includes tests.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
