Welcome to GSpy: Geophysical Data Standard in Python

This package provides functions and workflows for standardizing geophysical datasets based on the NetCDF file format. The current implementation supports both tabular (unstructured or scattered) and raster (structured or gridded) datasets.

Goals

1. Standardize a geophysical data format based on the Climate and Forecast (CF) metadata conventions and NetCDF format.

2. Restructure various types of geophysical data (e.g., raw and processed data, inverted models, or derivative products) into a consistent format for sharing and archiving.

3. Document critical metadata pertinent to geophysical analysis and transferability.

4. Develop tools for processing data and preparing data for inversion.

5. Develop exploratory and visualization tools to interrogate data.

NetCDF Data Standard

Datasets are read from a variety of original formats (CSV, ASEG-GDF, GeoTIFF) and reconfigured to follow a NetCDF based data standard, which includes detailed metadata:

1. All variables have detailed attributes (names, units, null values, value ranges).

2. Contains supporting information on the survey, data collection, and modeling parameters.

3. Standardized coordinate reference system (CRS) variables for maximum portability to other GIS software (QGIS, ArcGIS, etc).

4. Inputs with different CRSs are reprojected to be consistent for a given survey.

5. NetCDF is immediately scalable for large datasets, it has efficient read/write and parallel capabilities.

• Getting Started
  • Installing GSpy
  • Importing aseg-gdf2 files into the GSPy Survey
    • Mapping the DFN to the CF metadata convention
• API
  • Classes
    • Data classes
      • GS xarray accessor classes
        • gs_DataArray
          • DataArray
            • DataArray.add_bounds_to_coordinate_dimension()
            • DataArray.catch_nan()
            • DataArray.check_metadata()
            • DataArray.from_values()
            • DataArray.label
            • DataArray.valid_range()
        • gs_Coordinate
          • Coordinate
            • Coordinate.check_is_projected()
            • Coordinate.check_standard_coordinates()
            • Coordinate.from_dict()
            • Coordinate.from_values()
        • gs_Dataset
          • Dataset
            • Dataset.add_bounds_to_coordinate()
            • Dataset.add_coordinate_from_dict()
            • Dataset.add_coordinate_from_values()
            • Dataset.add_variable_from_values()
            • Dataset.is_projected
            • Dataset.json_metadata
            • Dataset.open_dataset()
            • Dataset.open_netcdf()
            • Dataset.plot()
            • Dataset.read_metadata()
            • Dataset.scatter()
            • Dataset.set_spatial_ref()
            • Dataset.spatial_ref
            • Dataset.update_attrs()
            • Dataset.write_ncml()
            • Dataset.write_netcdf()
            • Dataset.write_zarr()
      • Tabular
        • Tabular
          • Tabular.count_column_headers()
          • Tabular.get_fortran_format()
          • Tabular.is_netcdf
          • Tabular.open_netcdf()
          • Tabular.read()
          • Tabular.type
          • Tabular.write_netcdf()
          • Tabular.write_zarr()
      • Tabular_csv
        • Tabular_csv
          • Tabular_csv.file_handler
          • Tabular_csv.get_attrs()
          • Tabular_csv.write_csv()
      • Tabular_aseg
        • Tabular_aseg
          • Tabular_aseg.cols
          • Tabular_aseg.column_names
          • Tabular_aseg.file_handler
          • Tabular_aseg.get_attrs()
          • Tabular_aseg.write_aseg_dfn_file()
          • Tabular_aseg.write_metadata_template()
      • Raster
        • Raster
          • Raster.bounds
          • Raster.is_tif
          • Raster.read()
          • Raster.read_raster_using_metadata()
          • Raster.read_tif()
          • Raster.read_var_netcdf()
          • Raster.to_tif()
          • Raster.write_metadata_template()
          • Raster.write_netcdf()
          • Raster.write_zarr()
    • Survey class
      • Survey
        • Survey
          • Survey.add_raster()
          • Survey.add_tabular()
          • Survey.contents
          • Survey.open_netcdf()
          • Survey.raster
          • Survey.read_metadata()
          • Survey.reproject()
          • Survey.spatial_ref
          • Survey.tabular
          • Survey.write_metadata_template()
          • Survey.write_ncml()
          • Survey.write_netcdf()
          • Survey.write_zarr()
          • Survey.xarray
• Examples
  • Creating GS Files
  • Interacting With GS Files
• GS Convention Requirements