Skip to content

ifmeo-hamburg/seagliderOG1

Repository files navigation

seagliderOG1

This repository is intended to convert Seaglider basestation files (pSSSDDDD*.nc) into OG1 format.

Code is based on code from votoutils.

Organisation

Scripts within the seagliderOG1 package are divided by functionality:

  • readers.py reads basestation files (*.nc) from a server or local directory
  • writers.py writes OG1 *.nc files, default directory data/
  • plotters.py contains some basic plotting and viewing functions
  • convertOG1.py converts the basestation files to OG1 format
  • vocabularies.py contains some of the vocabulary translation (might be better as a YAML file)
  • seaglider_registr.txt has checksums for data files
  • tools.py functions the user may want to use
  • utilities.py functions the user probably will never need to call (only used in other functions)

Directory

File directory structure is as follows.

seagliderOG1/

  • .github/
  • config/
    • OG1_author.yaml
    • OG1_global_attrs.yaml
    • OG1_global_attrs.yaml
    • OG1_sensor_attrs.yaml
    • OG1_var_names.yaml
    • OG1_vocab_attrs.yaml
    • mission_yaml.yaml
  • data/
    • test.nc
  • notebooks/
    • dev_notebooks/
      • dev-troubleshoot.ipynb
      • download_and_register.ipynb
    • demo.ipynb
  • seagliderOG1/
    • convertOG1.py
    • plotters.py
    • readers.py
    • seaglider_registry.txt
    • tools.py
    • utilities.py
    • vocabularies.py
    • writers.py
  • tests/
    • test_readers.py
  • .gitignore
  • LICENSE
  • README.md
  • requirements-dev.txt
  • requirements.txt

Status

Still early days, but collaborations welcome!