ncdata

NetCDF data interoperability.

Represents generic netcdf data in Python objects, with translation to and from common analysis packages, so that netcdf-based data can be freely exchanged between packages without data copying, and data storage formatting can be precisely controlled.

In particular Ncdata exchanges data between Xarray and Iris as efficiently as possible.

“lossless, copy-free and lazy-preserving”.

This enables the user to freely mix+match operations from both projects, getting the “best of both worlds”.

User Documentation

For now, we don’t yet have much documentation beyond this page, and the API notes.

• a general project introduction is provide in the project README, along with all the current project status information.

  • Please see : README

• Some simple usage examples (scripts) are provided in the codebase.

  • Please see : Testcode scripts

API documentation

• ncdata
  • ncdata package
    • NameMap
      • NameMap.__init__()
      • NameMap.item_type
      • NameMap.copy()
      • NameMap.add()
      • NameMap.addall()
      • NameMap.rename()
      • NameMap.from_items()
      • NameMap.__new__()
      • NameMap.clear()
      • NameMap.fromkeys()
      • NameMap.get()
      • NameMap.items()
      • NameMap.keys()
      • NameMap.pop()
      • NameMap.popitem()
      • NameMap.setdefault()
      • NameMap.update()
      • NameMap.values()
    • NcAttribute
      • NcAttribute.__init__()
      • NcAttribute.name
      • NcAttribute.value
      • NcAttribute.as_python_value()
    • NcData
      • NcData.__init__()
      • NcData.name
      • NcData.dimensions
      • NcData.variables
      • NcData.attributes
      • NcData.groups
      • NcData.get_attrval()
      • NcData.set_attrval()
    • NcDimension
      • NcDimension.__init__()
      • NcDimension.name
      • NcDimension.size
      • NcDimension.unlimited
    • NcVariable
      • NcVariable.__init__()
      • NcVariable.name
      • NcVariable.dimensions
      • NcVariable.data
      • NcVariable.attributes
      • NcVariable.group
      • NcVariable.get_attrval()
      • NcVariable.set_attrval()
    • Subpackages
      • ncdata.utils package
        • save_errors()
    • Submodules
      • ncdata.dataset_like module
        • Nc4DatasetLike
        • Nc4VariableLike
        • Nc4DimensionLike
      • ncdata.iris module
        • from_iris()
        • to_iris()
      • ncdata.iris_xarray module
        • cubes_from_xarray()
        • cubes_to_xarray()
      • ncdata.netcdf4 module
        • from_nc4()
        • to_nc4()
      • ncdata.threadlock_sharing module
        • enable_lockshare()
        • disable_lockshare()
        • lockshare_context()
      • ncdata.xarray module
        • to_xarray()
        • from_xarray()

Indices and tables

• Index

• Module Index

• Search Page