Skip to main content


Logo

GERG Glider Ingest

Convert raw data from GERG gliders into netcdf using python
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

This project was created to streamline the process of converting the raw data from the gliders after missions into NetCDF files, as well as ensuring the code can be easily maintained, understood, and used by others.

Built With

Python

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

  1. Creating your own virtual environment then installing dependencies

    You can change "glider_ingest" to your desired environment name

    conda create -n glider_ingest python=3.12
    
    conda activate glider_ingest
    
    pip install numpy pandas xarray gsw attrs
    
  2. Using an already established virtual environment

    conda activate your_env
    
    pip install numpy pandas xarray gsw attrs
    

Installation

  1. Activate your virtual environment
  2. Verify/Install Dependencies
  3. Clone the repo
    git clone https://github.com/alecmkrueger/glider-ingest.git
    

Usage

Process raw data from gliders using python.

Function inputs:

  • raw_data_source (Path|str): Raw data source, from the glider SD card
  • working_directory (Path|str): Where you want the raw copy and processed data to be
  • glider_number (str): The number of the glider, for NetCDF metadata
  • mission_title (str): The mission title, for NetCDF metadata
  • extensions (list): The extensions you wish to process
  • output_nc_filename (str): The name of the output NetCDF file
  • return_ds (bool): If you would like the output dataset to be returned. Default = False

Example:

from pathlib import Path

from glider_ingest import MissionData, MissionProcessor

memory_card_copy_loc = Path('path/to/memory/card/copy')
# Where you want the netcdf to be saved to
working_dir = Path('path/to/working/dir').resolve()
mission_num = '46'

# Initalize the mission_data container
mission_data = MissionData(memory_card_copy_loc=memory_card_copy_loc,
                         working_dir=working_dir,
                         mission_num=mission_num)
# Pass the mission_data container to the MissionProcessor class
# call save_mission_dataset to generate and save the mission dataset
MissionProcessor(mission_data=mission_data).save_mission_dataset()

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 - alecmkrueger@tamu.edu

Project Link: https://github.com/alecmkrueger/glider-ingest

Acknowledgments

  • Sakib Mahmud, Texas A&M University, Geochemical and Environmental Research Group, sakib@tamu.edu
  • Xiao Ge, Texas A&M University, Geochemical and Environmental Research Group, gexiao@tamu.edu
  • Alec Krueger, Texas A&M University, Geochemical and Environmental Research Group, alecmkrueger@tamu.edu

(back to top)

Metadata

Release files for glider-ingest 1.1.23

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for glider-ingest 1.1.23
File Size Uploaded
glider_ingest-1.1.23.tar.gz 25.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for glider-ingest 1.1.23
File Interpreter ABI Platform
glider_ingest-1.1.23-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details

Total release size: 52.0 kB

Release files / glider_ingest-1.1.23.tar.gz

Download URL glider_ingest-1.1.23.tar.gz
Size 25.6 kB
Tags Source
SHA-256 checksum
How to use checksums
8bf7aad70304aebc605464f4a9514ecac857f8b0b9bf462a00cad4e526b1b8ee
BLAKE2b-256 checksum
How to use checksums
50143915e37b57ee357b051a998765ce4dcc0fe24339c79b8f62bb151a215712
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.12.8 Windows/11

Release files / glider_ingest-1.1.23-cp312-cp312-win_amd64.whl

Download URL glider_ingest-1.1.23-cp312-cp312-win_amd64.whl
Size 26.3 kB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
7c04944fbc59fd72fe19def47e3284d34e5fa575b2076762e64b958b197f564a
BLAKE2b-256 checksum
How to use checksums
2be17c78dd4689a62d336f72c00d6be8df1c67fce4b72930d6e39e0afc43f6f0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.2.1 CPython/3.12.8 Windows/11

Release history Release notifications | RSS feed

This release

1.1.23 This release

2 release files

1.1.21

2 release files

1.1.20

2 release files

1.1.19

2 release files

1.1.18

2 release files

1.1.13

2 release files

1.1.12

2 release files

1.1.11

2 release files

1.1.10

2 release files

1.1.9

2 release files

1.1.8

2 release files

1.1.7

2 release files

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.3

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page