Metadata-Version: 2.4
Name: gerg-plotting
Version: 0.1.0
Summary: A Python package for plotting oceanographic data, developed by Alec Krueger at Texas A&M University.
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: attrs>=25.4.0
Requires-Dist: cartopy>=0.25.0
Requires-Dist: cmocean>=4.0.3
Requires-Dist: configobj>=5.0.9
Requires-Dist: gsw>=3.6.21
Requires-Dist: imageio>=2.37.2
Requires-Dist: matplotlib>=3.10.8
Requires-Dist: netcdf4>=1.7.4
Requires-Dist: notebook>=7.5.4
Requires-Dist: opencv-python>=4.13.0.92
Requires-Dist: pyvista>=0.47.1
Requires-Dist: scipy>=1.17.1
Requires-Dist: trame>=3.12.0
Requires-Dist: trame-vtk>=2.11.1
Requires-Dist: xarray>=2026.2.0

<a id="readme-top"></a>

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/alecmkrueger/gerg_plotting">
    <img src="https://raw.githubusercontent.com/alecmkrueger/gerg_plotting/ac19c0862d5ea23eda682830283f9698073cae04/.github/gerg_logo.svg" alt="GERG Logo" width="500" height="272">
  </a>

<h3 align="center">GERG Plotting</h3>

  <p align="center">
    Data plotting package for GERG
    <br />
    <a href="https://gerg-plotting.readthedocs.io/en/latest/"><strong>Explore the docs »</strong></a>
    <br />
    <br />
    <a href="https://github.com/alecmkrueger/gerg_plotting/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
    ·
    <a href="https://github.com/alecmkrueger/gerg_plotting/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
  </p>
</div>


<!-- ABOUT THE PROJECT -->
## About The Project

This project streamlines and standardizes the process of generating plots at GERG.



### Built With

[![Python][Python]][Python-url]



<!-- GETTING STARTED -->
## Getting Started


There are two ways to get started
1. Create a fresh virtual environment using your favorite method and install the package (recommended)
2. Use an already established virtual environment and install the package


### Installation

1. Create and/or activate your virtual environment with python >=3.12
1. Use pip to install ```pip install gerg_plotting```

### View Example Code
[Examples at Read The Docs](https://gerg-plotting.readthedocs.io/en/latest/auto_examples/index.html)

### View Code Documentation 
[API Reference at Read The Docs](https://gerg-plotting.readthedocs.io/en/latest/autoapi/index.html)



<!-- CONTRIBUTING -->
## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request





<!-- LICENSE -->
## License

Distributed under the MIT License. See `LICENSE` for more information.



<!-- CONTACT -->
## Contact

Alec Krueger - alecmkrueger@tamu.edu

Repository: [https://github.com/alecmkrueger/gerg_plotting](https://github.com/alecmkrueger/gerg_plotting)

PyPi: [https://pypi.org/project/gerg_plotting/](https://pypi.org/project/gerg_plotting/)

Read The Docs: [https://gerg-plotting.readthedocs.io/en/latest/](https://gerg-plotting.readthedocs.io/en/latest/)



<!-- ACKNOWLEDGMENTS -->
## Acknowledgments

* Alec Krueger, Texas A&M University, Geochemical and Environmental Research Group, alecmkrueger@tamu.edu

<p align="right">(<a href="#readme-top">back to top</a>)</p>



<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/alecmkrueger/gerg_plotting.svg?style=for-the-badge
[contributors-url]: https://github.com/alecmkrueger/gerg_plotting/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/alecmkrueger/gerg_plotting.svg?style=for-the-badge
[forks-url]: https://github.com/alecmkrueger/gerg_plotting/network/members
[stars-shield]: https://img.shields.io/github/stars/alecmkrueger/gerg_plotting.svg?style=for-the-badge
[stars-url]: https://github.com/alecmkrueger/gerg_plotting/stargazers
[issues-shield]: https://img.shields.io/github/issues/alecmkrueger/gerg_plotting.svg?style=for-the-badge
[issues-url]: https://github.com/alecmkrueger/gerg_plotting/issues
[license-shield]: https://img.shields.io/github/license/alecmkrueger/gerg_plotting.svg?style=for-the-badge
[license-url]: https://github.com/alecmkrueger/gerg_plotting/LICENSE
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/aleckrueger
[product-screenshot]: images/screenshot.png
[Python]: https://img.shields.io/badge/python-000000?&logo=python
[Python-url]: https://www.python.org/
