gerg_plotting 0.0.9

No project description provided

GERG Plotting

Data plotting package for GERG
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Dependencies
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

This project was created to streamline and standardize the process of generating plots at GERG.

Built With

Getting Started

There are three ways to get started

1. Create a fresh virtual environment using your favorite method and install the dependencies
2. Use an already established virtual environment and install the dependencies

Dependencies

I have provided some commands to install the dependencies using conda but you can use any package manager

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
2. Use pip to install pip install gerg_glider

Usage

Plot data at GERG using Python.

Create Histgrams for U and V current vectors

import xarray as xr
import matplotlib.pyplot as plt
from gerg_plotting import Histogram, Buoy

# Open in the dataset
ds = xr.open_dataset('../test_data/buoy.nc')
# Convert the dataset to pandas dataframe
df = ds[['u','v']].to_dataframe().reset_index()

# Initialize the buoy instrument data container
buoy = Buoy(depth=df['bin'].to_numpy(),
            time=df['date'].to_numpy(),
            u_current=df['u'].to_numpy(),
            v_current=df['v'].to_numpy())

# Initialize the figure and axes
fig,axes = plt.subplots(nrows=2,figsize = (5,10))
# Initialize the histogram plotter
hist = Histogram(instrument=buoy)
# Plot the 1-d histograms for u and v currents
hist.plot(fig=fig,ax=axes[0],var='u_current',bins=100)
hist.plot(fig=fig,ax=axes[1],var='v_current',bins=100)
# Add Titles to Histograms
axes[0].set_title('Current Vector U')
axes[1].set_title('Current Vector V')
# Show Figure
plt.show()

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

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

Contact

Alec Krueger - [e-mail]

Project Link: https://github.com/alecmkrueger/gerg_plotting

Acknowledgments

• Alec Krueger, Texas A&M University, Geochemical and Environmental Research Group, [e-mail]

(back to top)