| Name | gerg_plotting JSON |
| Version |
0.0.27
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-01-13 18:38:36 |
| maintainer | None |
| docs_url | None |
| author | Alec Krueger |
| requires_python | <4.0,>=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<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/project_images/9af2f8f58c93e183ac5473a4474619407aee08d3/gerg_logo.svg" alt="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>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#dependencies">Dependencies</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
This project was created to streamline and standardize 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
2. Use an already established virtual environment and install the package
### Dependencies
I have provided a list of the dependencies and their versions below.
List of dependencies:
* python = 3.12
* numpy = 2.0.0
* pandas = 2.2.2
* matplotlib = 3.9.1
* xarray = 2024.6.0
* attrs = 23.2.0
* netcdf4 = 1.7.1.post1
* cmocean = 4.0.3
* scipy = 1.14.0
* mayavi = 4.8.2
### Installation
1. Activate your virtual environment
1. Use pip to install ```pip install gerg_plotting```
<!-- USAGE EXAMPLES -->
## Usage
Plot data at GERG using Python.
Example: Create a set of maps showing data point temperature, salinity, depth, and time
```sh
from gerg_plotting import MapPlot,Bounds,data_from_csv
import matplotlib.pyplot as plt
import cartopy.crs as ccrs
# Define bounds
bounds = Bounds(lat_min = 24,lat_max = 31,lon_min = -99,lon_max = -88,depth_top=-1,depth_bottom=1000)
# Let's read in the example data
data = data_from_csv('example_data/sample_glider_data.csv')
data.bounds = bounds
# Init subplots
fig,ax = plt.subplots(figsize=(10,15),nrows=4,subplot_kw={'projection': ccrs.PlateCarree()},layout='constrained')
# Init MapPlot object
plotter = MapPlot(data=data,grid_spacing=3)
# # Generate Scatter plots on one figure
plotter.scatter(fig=fig,ax=ax[0],var='temperature',show_bathy=True,pointsize=30)
plotter.scatter(fig=fig,ax=ax[1],var='salinity',show_bathy=True,pointsize=30)
plotter.scatter(fig=fig,ax=ax[2],var='depth',show_bathy=True,pointsize=30)
plotter.scatter(fig=fig,ax=ax[3],var='time',show_bathy=True,pointsize=30)
plt.show()
fig.savefig('example_plots/map_example.png',dpi=500,bbox_inches='tight')
```
<!-- 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
Project Link: [https://github.com/alecmkrueger/gerg_plotting](https://github.com/alecmkrueger/gerg_plotting)
<!-- 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/
Raw data
{
"_id": null,
"home_page": null,
"name": "gerg_plotting",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Alec Krueger",
"author_email": "alecmkrueger@tamu.edu",
"download_url": "https://files.pythonhosted.org/packages/2e/e7/2004e55e871c1020ed14477080e9e5bd4bd462346ca5039f2e0fce8ba202/gerg_plotting-0.0.27.tar.gz",
"platform": null,
"description": "<a id=\"readme-top\"></a>\n\n<!-- PROJECT LOGO -->\n<br />\n<div align=\"center\">\n <a href=\"https://github.com/alecmkrueger/gerg_plotting\">\n <img src=\"https://raw.githubusercontent.com/alecmkrueger/project_images/9af2f8f58c93e183ac5473a4474619407aee08d3/gerg_logo.svg\" alt=\"Logo\" width=\"500\" height=\"272\">\n </a>\n\n<h3 align=\"center\">GERG Plotting</h3>\n\n <p align=\"center\">\n Data plotting package for GERG\n <br />\n <a href=\"https://gerg-plotting.readthedocs.io/en/latest/\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n <br />\n <a href=\"https://github.com/alecmkrueger/gerg_plotting/issues/new?labels=bug&template=bug-report---.md\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/alecmkrueger/gerg_plotting/issues/new?labels=enhancement&template=feature-request---.md\">Request Feature</a>\n </p>\n</div>\n\n\n\n<!-- TABLE OF CONTENTS -->\n<details>\n <summary>Table of Contents</summary>\n <ol>\n <li>\n <a href=\"#about-the-project\">About The Project</a>\n <ul>\n <li><a href=\"#built-with\">Built With</a></li>\n </ul>\n </li>\n <li>\n <a href=\"#getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#dependencies\">Dependencies</a></li>\n <li><a href=\"#installation\">Installation</a></li>\n </ul>\n </li>\n <li><a href=\"#usage\">Usage</a></li>\n <li><a href=\"#contributing\">Contributing</a></li>\n <li><a href=\"#license\">License</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n <li><a href=\"#acknowledgments\">Acknowledgments</a></li>\n </ol>\n</details>\n\n\n\n<!-- ABOUT THE PROJECT -->\n## About The Project\n\nThis project was created to streamline and standardize the process of generating plots at GERG.\n\n\n\n### Built With\n\n[![Python][Python]][Python-url]\n\n\n\n<!-- GETTING STARTED -->\n## Getting Started\n\nThere are two ways to get started\n1. Create a fresh virtual environment using your favorite method and install the package\n2. Use an already established virtual environment and install the package\n\n\n\n### Dependencies\nI have provided a list of the dependencies and their versions below.\n\nList of dependencies:\n* python = 3.12\n* numpy = 2.0.0\n* pandas = 2.2.2\n* matplotlib = 3.9.1\n* xarray = 2024.6.0\n* attrs = 23.2.0\n* netcdf4 = 1.7.1.post1\n* cmocean = 4.0.3\n* scipy = 1.14.0\n* mayavi = 4.8.2\n\n\n### Installation\n\n1. Activate your virtual environment\n1. Use pip to install ```pip install gerg_plotting```\n\n\n\n<!-- USAGE EXAMPLES -->\n## Usage\n\nPlot data at GERG using Python.\n\nExample: Create a set of maps showing data point temperature, salinity, depth, and time\n```sh\nfrom gerg_plotting import MapPlot,Bounds,data_from_csv\nimport matplotlib.pyplot as plt\nimport cartopy.crs as ccrs\n\n# Define bounds\nbounds = Bounds(lat_min = 24,lat_max = 31,lon_min = -99,lon_max = -88,depth_top=-1,depth_bottom=1000)\n# Let's read in the example data\ndata = data_from_csv('example_data/sample_glider_data.csv')\ndata.bounds = bounds\n\n# Init subplots\nfig,ax = plt.subplots(figsize=(10,15),nrows=4,subplot_kw={'projection': ccrs.PlateCarree()},layout='constrained')\n# Init MapPlot object\nplotter = MapPlot(data=data,grid_spacing=3)\n# # Generate Scatter plots on one figure\nplotter.scatter(fig=fig,ax=ax[0],var='temperature',show_bathy=True,pointsize=30)\nplotter.scatter(fig=fig,ax=ax[1],var='salinity',show_bathy=True,pointsize=30)\nplotter.scatter(fig=fig,ax=ax[2],var='depth',show_bathy=True,pointsize=30)\nplotter.scatter(fig=fig,ax=ax[3],var='time',show_bathy=True,pointsize=30)\nplt.show()\nfig.savefig('example_plots/map_example.png',dpi=500,bbox_inches='tight')\n```\n\n\n<!-- CONTRIBUTING -->\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf 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\".\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\n\n\n\n<!-- LICENSE -->\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\n\n\n<!-- CONTACT -->\n## Contact\n\nAlec Krueger - alecmkrueger@tamu.edu\n\nProject Link: [https://github.com/alecmkrueger/gerg_plotting](https://github.com/alecmkrueger/gerg_plotting)\n\n\n\n<!-- ACKNOWLEDGMENTS -->\n## Acknowledgments\n\n* Alec Krueger, Texas A&M University, Geochemical and Environmental Research Group, alecmkrueger@tamu.edu\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\n[contributors-shield]: https://img.shields.io/github/contributors/alecmkrueger/gerg_plotting.svg?style=for-the-badge\n[contributors-url]: https://github.com/alecmkrueger/gerg_plotting/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/alecmkrueger/gerg_plotting.svg?style=for-the-badge\n[forks-url]: https://github.com/alecmkrueger/gerg_plotting/network/members\n[stars-shield]: https://img.shields.io/github/stars/alecmkrueger/gerg_plotting.svg?style=for-the-badge\n[stars-url]: https://github.com/alecmkrueger/gerg_plotting/stargazers\n[issues-shield]: https://img.shields.io/github/issues/alecmkrueger/gerg_plotting.svg?style=for-the-badge\n[issues-url]: https://github.com/alecmkrueger/gerg_plotting/issues\n[license-shield]: https://img.shields.io/github/license/alecmkrueger/gerg_plotting.svg?style=for-the-badge\n[license-url]: https://github.com/alecmkrueger/gerg_plotting/LICENSE\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\n[linkedin-url]: https://linkedin.com/in/aleckrueger\n[product-screenshot]: images/screenshot.png\n[Python]: https://img.shields.io/badge/python-000000?&logo=python\n[Python-url]: https://www.python.org/",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.27",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c85160fe3d55eae7c91345471148f8a7f65190e3d178c746be40485007d4be8b",
"md5": "f4e80ef019980f0bd5b47be2781962d7",
"sha256": "47a758f6ad43dc43a1150c16abc7743e46a567d175795c4dd0ddb0de9d949d44"
},
"downloads": -1,
"filename": "gerg_plotting-0.0.27-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4e80ef019980f0bd5b47be2781962d7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 70492169,
"upload_time": "2025-01-13T18:37:46",
"upload_time_iso_8601": "2025-01-13T18:37:46.401973Z",
"url": "https://files.pythonhosted.org/packages/c8/51/60fe3d55eae7c91345471148f8a7f65190e3d178c746be40485007d4be8b/gerg_plotting-0.0.27-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2ee72004e55e871c1020ed14477080e9e5bd4bd462346ca5039f2e0fce8ba202",
"md5": "8e9c7c82d2f3c3ec2e153126ea297882",
"sha256": "eab2d46200b8c90c1746edcb8165773f50996a8051249f3da60c7a0e23c2fdf2"
},
"downloads": -1,
"filename": "gerg_plotting-0.0.27.tar.gz",
"has_sig": false,
"md5_digest": "8e9c7c82d2f3c3ec2e153126ea297882",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 70407472,
"upload_time": "2025-01-13T18:38:36",
"upload_time_iso_8601": "2025-01-13T18:38:36.086863Z",
"url": "https://files.pythonhosted.org/packages/2e/e7/2004e55e871c1020ed14477080e9e5bd4bd462346ca5039f2e0fce8ba202/gerg_plotting-0.0.27.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-13 18:38:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gerg_plotting"
}
