diff --git a/docs/source/check_docs_api_coverage.py b/docs/source/check_docs_api_coverage.py index 06eb8e9be..de80a8899 100644 --- a/docs/source/check_docs_api_coverage.py +++ b/docs/source/check_docs_api_coverage.py @@ -1,4 +1,6 @@ -"""Check the method-coverage of all classes in docs/source/class.rst. +"""Check the class-coverage and method-coverage of the API reference. + +All classes are extracted and checked for an entry in docs/source/class.rst All non-private methods of all such classes are checked for having an entry in their corresponding class's file in docs/source/class/ @@ -16,6 +18,7 @@ """ +import inspect import os import re import sys @@ -34,8 +37,10 @@ if not source.endswith("source"): raise ValueError(f"Given directory {source} does not end with 'source'") +n_undocumented_classes = 0 n_undocumented_methods = 0 n_missing_files = 0 + duplicate_method_entries = [] for core in ("", "_core"): @@ -50,12 +55,26 @@ api_contents = f.read() class_names = [ - i.split(".")[-1] - for i in api_contents.split("\n") - if package.__name__ + "." in i + name + for name, klass in inspect.getmembers(package, inspect.isclass) + if klass.__module__.startswith(package.__name__ + ".") + and not klass.__module__.startswith(package.__name__ + ".functions") + # This just counts top-level read-write i.e. cfdm.read and .write + and not klass.__module__.startswith(package.__name__ + ".read_write") + and name != "netcdf_indexer" # lone function ] for class_name in class_names: + full_class_name = f"{package.__name__}.{class_name}" + + if full_class_name not in api_contents: + print( + f"Class {full_class_name} not in docs/source/class{core}.rst" + ) + n_missing_files += 1 + n_undocumented_classes += 1 + continue + klass = getattr(package, class_name) methods = [ method for method in dir(klass) if not method.startswith("_") @@ -63,7 +82,7 @@ class_name = ".".join([package.__name__, class_name]) - rst_file = os.path.join(source, "class", class_name + ".rst") + rst_file = os.path.join(source, "class", full_class_name + ".rst") try: with open(rst_file) as f: @@ -100,7 +119,7 @@ duplicate_method_entries.append(method) except FileNotFoundError: n_missing_files += 1 - print(f"File {rst_file} does not exist") + print(f"File {rst_file} does not exist for existing class") # Raise an exception to ensure a non-zero shell return code if n_undocumented_methods: @@ -111,8 +130,9 @@ if n_undocumented_methods or n_missing_files: raise ValueError( - f"Found undocumented methods ({n_undocumented_methods}) " - f"or missing .rst files ({n_missing_files})" + f"Found {n_undocumented_classes} undocumented classes, " + f"{n_undocumented_methods} undocumented methods and " + f"{n_missing_files} missing .rst files" ) if duplicate_method_entries: diff --git a/docs/source/class.rst b/docs/source/class.rst index 6e4e616bb..79fa16811 100644 --- a/docs/source/class.rst +++ b/docs/source/class.rst @@ -10,6 +10,8 @@ Version |release| for version |version| of the CF conventions. +.. note:: See also the :ref:`class_core`. + Field construct class --------------------- @@ -76,10 +78,29 @@ Data classes :toctree: class/ cfdm.Data + + +Array classes +------------- + +Classes that support the creation and storage of arrays. + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cfdm.Array cfdm.NetCDF4Array cfdm.H5netcdfArray cfdm.ZarrArray - cfdm.Array + cfdm.AggregatedArray + cfdm.FullArray + cfdm.NetCDFArray + cfdm.NumpyArray + cfdm.PyfiveArray + cfdm.ScipyNetcdfFileArray + cfdm.SparseArray + Data compression classes ------------------------ @@ -94,11 +115,63 @@ Classes that support the creation and storage of compressed arrays. cfdm.Index cfdm.List cfdm.GatheredArray + cfdm.RaggedArray + cfdm.RaggedSubarray cfdm.RaggedContiguousArray cfdm.RaggedIndexedArray cfdm.RaggedIndexedContiguousArray cfdm.CompressedArray cfdm.Quantization + cfdm.BiLinearSubarray + cfdm.BiQuadraticLatitudeLongitudeSubarray + cfdm.GatheredSubarray + cfdm.InterpolationSubarray + cfdm.LinearSubarray + cfdm.QuadraticLatitudeLongitudeSubarray + cfdm.QuadraticSubarray + cfdm.Subarray + cfdm.SubsampledArray + cfdm.SubsampledSubarray + +UGRID related classes +--------------------- + +Classes that support the creation and storage of UGRID related arrays. + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cfdm.BoundsFromNodesArray + cfdm.BoundsFromNodesSubarray + cfdm.CellConnectivityArray + cfdm.CellConnectivitySubarray + cfdm.PointTopologyArray + +Abstract base classes +--------------------- + +Abstract base classes that provide the basis for constructs and +construct components. + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cfdm.NodeCountProperties + cfdm.PartNodeCountProperties + cfdm.Container + +Implementation classes +---------------------- + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cfdm.Implementation + cfdm.CFDMImplementation + Miscellaneous classes --------------------- @@ -109,4 +182,6 @@ Miscellaneous classes cfdm.Constant cfdm.Configuration - + cfdm.InterpolationParameter + cfdm.TiePointIndex + cfdm.Units diff --git a/docs/source/class/cfdm.AggregatedArray.rst b/docs/source/class/cfdm.AggregatedArray.rst new file mode 100644 index 000000000..60a54b196 --- /dev/null +++ b/docs/source/class/cfdm.AggregatedArray.rst @@ -0,0 +1,56 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.AggregatedArray +==================== + +---- + +.. autoclass:: cfdm.AggregatedArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.AggregatedArray.Units + ~cfdm.AggregatedArray.array + ~cfdm.AggregatedArray.astype + ~cfdm.AggregatedArray.close + ~cfdm.AggregatedArray.copy + ~cfdm.AggregatedArray.dtype + ~cfdm.AggregatedArray.file_directory + ~cfdm.AggregatedArray.get_address + ~cfdm.AggregatedArray.get_attributes + ~cfdm.AggregatedArray.get_calendar + ~cfdm.AggregatedArray.get_compression_type + ~cfdm.AggregatedArray.get_filename + ~cfdm.AggregatedArray.get_fragment_array + ~cfdm.AggregatedArray.get_fragment_array_shape + ~cfdm.AggregatedArray.get_fragment_type + ~cfdm.AggregatedArray.get_fragmented_dimensions + ~cfdm.AggregatedArray.get_mask + ~cfdm.AggregatedArray.get_missing_values + ~cfdm.AggregatedArray.get_storage_options + ~cfdm.AggregatedArray.get_storage_protocol + ~cfdm.AggregatedArray.get_units + ~cfdm.AggregatedArray.get_unpack + ~cfdm.AggregatedArray.get_variable + ~cfdm.AggregatedArray.has_remote_storage_protocol + ~cfdm.AggregatedArray.ndim + ~cfdm.AggregatedArray.open + ~cfdm.AggregatedArray.replace_directory + ~cfdm.AggregatedArray.replace_filename + ~cfdm.AggregatedArray.shape + ~cfdm.AggregatedArray.size + ~cfdm.AggregatedArray.subarray_shapes + ~cfdm.AggregatedArray.subarrays + ~cfdm.AggregatedArray.to_dask_array + ~cfdm.AggregatedArray.to_memory diff --git a/docs/source/class/cfdm.BiLinearSubarray.rst b/docs/source/class/cfdm.BiLinearSubarray.rst new file mode 100644 index 000000000..47eca4ea6 --- /dev/null +++ b/docs/source/class/cfdm.BiLinearSubarray.rst @@ -0,0 +1,44 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.BiLinearSubarray +===================== + +---- + +.. autoclass:: cfdm.BiLinearSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.BiLinearSubarray.Units + ~cfdm.BiLinearSubarray.array + ~cfdm.BiLinearSubarray.astype + ~cfdm.BiLinearSubarray.bounds + ~cfdm.BiLinearSubarray.compressed_dimensions + ~cfdm.BiLinearSubarray.copy + ~cfdm.BiLinearSubarray.data + ~cfdm.BiLinearSubarray.dependent_tie_points + ~cfdm.BiLinearSubarray.dtype + ~cfdm.BiLinearSubarray.first + ~cfdm.BiLinearSubarray.get_attributes + ~cfdm.BiLinearSubarray.get_calendar + ~cfdm.BiLinearSubarray.get_compression_type + ~cfdm.BiLinearSubarray.get_filename + ~cfdm.BiLinearSubarray.get_interpolation_description + ~cfdm.BiLinearSubarray.get_units + ~cfdm.BiLinearSubarray.indices + ~cfdm.BiLinearSubarray.ndim + ~cfdm.BiLinearSubarray.parameters + ~cfdm.BiLinearSubarray.shape + ~cfdm.BiLinearSubarray.size + ~cfdm.BiLinearSubarray.subarea_indices diff --git a/docs/source/class/cfdm.BiQuadraticLatitudeLongitudeSubarray.rst b/docs/source/class/cfdm.BiQuadraticLatitudeLongitudeSubarray.rst new file mode 100644 index 000000000..9738ddd6c --- /dev/null +++ b/docs/source/class/cfdm.BiQuadraticLatitudeLongitudeSubarray.rst @@ -0,0 +1,44 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.BiQuadraticLatitudeLongitudeSubarray +========================================= + +---- + +.. autoclass:: cfdm.BiQuadraticLatitudeLongitudeSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.Units + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.array + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.astype + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.bounds + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.compressed_dimensions + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.copy + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.data + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.dependent_tie_points + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.dtype + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.first + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.get_attributes + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.get_calendar + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.get_compression_type + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.get_filename + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.get_interpolation_description + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.get_units + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.indices + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.ndim + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.parameters + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.shape + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.size + ~cfdm.BiQuadraticLatitudeLongitudeSubarray.subarea_indices diff --git a/docs/source/class/cfdm.BoundsFromNodesArray.rst b/docs/source/class/cfdm.BoundsFromNodesArray.rst new file mode 100644 index 000000000..5e4accbc5 --- /dev/null +++ b/docs/source/class/cfdm.BoundsFromNodesArray.rst @@ -0,0 +1,50 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.BoundsFromNodesArray +========================= + +---- + +.. autoclass:: cfdm.BoundsFromNodesArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.BoundsFromNodesArray.Units + ~cfdm.BoundsFromNodesArray.array + ~cfdm.BoundsFromNodesArray.astype + ~cfdm.BoundsFromNodesArray.compressed_array + ~cfdm.BoundsFromNodesArray.compressed_dimensions + ~cfdm.BoundsFromNodesArray.conformed_data + ~cfdm.BoundsFromNodesArray.copy + ~cfdm.BoundsFromNodesArray.dtype + ~cfdm.BoundsFromNodesArray.get_Subarray + ~cfdm.BoundsFromNodesArray.get_attributes + ~cfdm.BoundsFromNodesArray.get_calendar + ~cfdm.BoundsFromNodesArray.get_cell_dimension + ~cfdm.BoundsFromNodesArray.get_compressed_axes + ~cfdm.BoundsFromNodesArray.get_compressed_dimension + ~cfdm.BoundsFromNodesArray.get_compression_type + ~cfdm.BoundsFromNodesArray.get_filename + ~cfdm.BoundsFromNodesArray.get_node_coordinates + ~cfdm.BoundsFromNodesArray.get_start_index + ~cfdm.BoundsFromNodesArray.get_units + ~cfdm.BoundsFromNodesArray.ndim + ~cfdm.BoundsFromNodesArray.shape + ~cfdm.BoundsFromNodesArray.size + ~cfdm.BoundsFromNodesArray.source + ~cfdm.BoundsFromNodesArray.subarray_parameters + ~cfdm.BoundsFromNodesArray.subarray_shapes + ~cfdm.BoundsFromNodesArray.subarrays + ~cfdm.BoundsFromNodesArray.to_dask_array + ~cfdm.BoundsFromNodesArray.to_memory diff --git a/docs/source/class/cfdm.BoundsFromNodesSubarray.rst b/docs/source/class/cfdm.BoundsFromNodesSubarray.rst new file mode 100644 index 000000000..d4ffe10ae --- /dev/null +++ b/docs/source/class/cfdm.BoundsFromNodesSubarray.rst @@ -0,0 +1,41 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.BoundsFromNodesSubarray +============================ + +---- + +.. autoclass:: cfdm.BoundsFromNodesSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.BoundsFromNodesSubarray.Units + ~cfdm.BoundsFromNodesSubarray.array + ~cfdm.BoundsFromNodesSubarray.astype + ~cfdm.BoundsFromNodesSubarray.cell_dimension + ~cfdm.BoundsFromNodesSubarray.compressed_dimensions + ~cfdm.BoundsFromNodesSubarray.copy + ~cfdm.BoundsFromNodesSubarray.data + ~cfdm.BoundsFromNodesSubarray.dtype + ~cfdm.BoundsFromNodesSubarray.get_attributes + ~cfdm.BoundsFromNodesSubarray.get_calendar + ~cfdm.BoundsFromNodesSubarray.get_compression_type + ~cfdm.BoundsFromNodesSubarray.get_filename + ~cfdm.BoundsFromNodesSubarray.get_units + ~cfdm.BoundsFromNodesSubarray.indices + ~cfdm.BoundsFromNodesSubarray.ndim + ~cfdm.BoundsFromNodesSubarray.node_coordinates + ~cfdm.BoundsFromNodesSubarray.shape + ~cfdm.BoundsFromNodesSubarray.size + ~cfdm.BoundsFromNodesSubarray.start_index diff --git a/docs/source/class/cfdm.CFDMImplementation.rst b/docs/source/class/cfdm.CFDMImplementation.rst new file mode 100644 index 000000000..8d8bec240 --- /dev/null +++ b/docs/source/class/cfdm.CFDMImplementation.rst @@ -0,0 +1,216 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.CFDMImplementation +======================= + +---- + +.. autoclass:: cfdm.CFDMImplementation + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.CFDMImplementation.bounds_insert_dimension + ~cfdm.CFDMImplementation.classes + ~cfdm.CFDMImplementation.climatological_time_axes + ~cfdm.CFDMImplementation.conform_geometry_variables + ~cfdm.CFDMImplementation.construct_insert_dimension + ~cfdm.CFDMImplementation.convert + ~cfdm.CFDMImplementation.copy + ~cfdm.CFDMImplementation.copy_construct + ~cfdm.CFDMImplementation.data_insert_dimension + ~cfdm.CFDMImplementation.del_parameter + ~cfdm.CFDMImplementation.del_properties + ~cfdm.CFDMImplementation.del_property + ~cfdm.CFDMImplementation.equal_components + ~cfdm.CFDMImplementation.equal_constructs + ~cfdm.CFDMImplementation.equal_datums + ~cfdm.CFDMImplementation.equal_properties + ~cfdm.CFDMImplementation.field_insert_dimension + ~cfdm.CFDMImplementation.get_array + ~cfdm.CFDMImplementation.get_auxiliary_coordinates + ~cfdm.CFDMImplementation.get_bounds + ~cfdm.CFDMImplementation.get_bounds_ncvar + ~cfdm.CFDMImplementation.get_cell_connectivities + ~cfdm.CFDMImplementation.get_cell_measures + ~cfdm.CFDMImplementation.get_cell_method_axes + ~cfdm.CFDMImplementation.get_cell_method_qualifiers + ~cfdm.CFDMImplementation.get_cell_method_string + ~cfdm.CFDMImplementation.get_cell_methods + ~cfdm.CFDMImplementation.get_cf_version + ~cfdm.CFDMImplementation.get_class + ~cfdm.CFDMImplementation.get_compressed_array + ~cfdm.CFDMImplementation.get_compressed_axes + ~cfdm.CFDMImplementation.get_compression_type + ~cfdm.CFDMImplementation.get_construct_data_axes + ~cfdm.CFDMImplementation.get_construct_data_size + ~cfdm.CFDMImplementation.get_construct_type + ~cfdm.CFDMImplementation.get_constructs + ~cfdm.CFDMImplementation.get_coordinate_conversion_parameters + ~cfdm.CFDMImplementation.get_coordinate_reference_coordinates + ~cfdm.CFDMImplementation.get_coordinate_references + ~cfdm.CFDMImplementation.get_coordinates + ~cfdm.CFDMImplementation.get_count + ~cfdm.CFDMImplementation.get_data + ~cfdm.CFDMImplementation.get_data_axes + ~cfdm.CFDMImplementation.get_data_calendar + ~cfdm.CFDMImplementation.get_data_compressed_axes + ~cfdm.CFDMImplementation.get_data_max + ~cfdm.CFDMImplementation.get_data_maximum + ~cfdm.CFDMImplementation.get_data_ndim + ~cfdm.CFDMImplementation.get_data_shape + ~cfdm.CFDMImplementation.get_data_size + ~cfdm.CFDMImplementation.get_data_source + ~cfdm.CFDMImplementation.get_data_sum + ~cfdm.CFDMImplementation.get_data_units + ~cfdm.CFDMImplementation.get_datum + ~cfdm.CFDMImplementation.get_datum_parameters + ~cfdm.CFDMImplementation.get_dimension_coordinates + ~cfdm.CFDMImplementation.get_domain_ancillaries + ~cfdm.CFDMImplementation.get_domain_axes + ~cfdm.CFDMImplementation.get_domain_axis_size + ~cfdm.CFDMImplementation.get_domain_topologies + ~cfdm.CFDMImplementation.get_field_ancillaries + ~cfdm.CFDMImplementation.get_field_data_axes + ~cfdm.CFDMImplementation.get_filenames + ~cfdm.CFDMImplementation.get_geometry + ~cfdm.CFDMImplementation.get_index + ~cfdm.CFDMImplementation.get_inherited_properties + ~cfdm.CFDMImplementation.get_interior_ring + ~cfdm.CFDMImplementation.get_interpolation_name + ~cfdm.CFDMImplementation.get_list + ~cfdm.CFDMImplementation.get_measure + ~cfdm.CFDMImplementation.get_node_count + ~cfdm.CFDMImplementation.get_original_filenames + ~cfdm.CFDMImplementation.get_parameter + ~cfdm.CFDMImplementation.get_part_node_count + ~cfdm.CFDMImplementation.get_properties + ~cfdm.CFDMImplementation.get_property + ~cfdm.CFDMImplementation.get_quantization + ~cfdm.CFDMImplementation.get_quantize_on_write + ~cfdm.CFDMImplementation.get_sample_dimension_position + ~cfdm.CFDMImplementation.get_tie_points + ~cfdm.CFDMImplementation.has_bounds + ~cfdm.CFDMImplementation.has_datum + ~cfdm.CFDMImplementation.has_domain_topology + ~cfdm.CFDMImplementation.has_property + ~cfdm.CFDMImplementation.initialise_AggregatedArray + ~cfdm.CFDMImplementation.initialise_AuxiliaryCoordinate + ~cfdm.CFDMImplementation.initialise_Bounds + ~cfdm.CFDMImplementation.initialise_BoundsFromNodesArray + ~cfdm.CFDMImplementation.initialise_CellConnectivity + ~cfdm.CFDMImplementation.initialise_CellConnectivityArray + ~cfdm.CFDMImplementation.initialise_CellMeasure + ~cfdm.CFDMImplementation.initialise_CellMethod + ~cfdm.CFDMImplementation.initialise_CoordinateConversion + ~cfdm.CFDMImplementation.initialise_CoordinateReference + ~cfdm.CFDMImplementation.initialise_Count + ~cfdm.CFDMImplementation.initialise_Data + ~cfdm.CFDMImplementation.initialise_Datum + ~cfdm.CFDMImplementation.initialise_DimensionCoordinate + ~cfdm.CFDMImplementation.initialise_DimensionCoordinate_from_AuxiliaryCoordinate + ~cfdm.CFDMImplementation.initialise_Domain + ~cfdm.CFDMImplementation.initialise_DomainAncillary + ~cfdm.CFDMImplementation.initialise_DomainAxis + ~cfdm.CFDMImplementation.initialise_DomainTopology + ~cfdm.CFDMImplementation.initialise_Field + ~cfdm.CFDMImplementation.initialise_FieldAncillary + ~cfdm.CFDMImplementation.initialise_GatheredArray + ~cfdm.CFDMImplementation.initialise_H5netcdfArray + ~cfdm.CFDMImplementation.initialise_Index + ~cfdm.CFDMImplementation.initialise_InteriorRing + ~cfdm.CFDMImplementation.initialise_InterpolationParameter + ~cfdm.CFDMImplementation.initialise_List + ~cfdm.CFDMImplementation.initialise_NetCDF4Array + ~cfdm.CFDMImplementation.initialise_NodeCountProperties + ~cfdm.CFDMImplementation.initialise_PartNodeCount + ~cfdm.CFDMImplementation.initialise_PointTopologyArray + ~cfdm.CFDMImplementation.initialise_PyfiveArray + ~cfdm.CFDMImplementation.initialise_Quantization + ~cfdm.CFDMImplementation.initialise_RaggedContiguousArray + ~cfdm.CFDMImplementation.initialise_RaggedIndexedArray + ~cfdm.CFDMImplementation.initialise_RaggedIndexedContiguousArray + ~cfdm.CFDMImplementation.initialise_ScipyNetcdfFileArray + ~cfdm.CFDMImplementation.initialise_SubsampledArray + ~cfdm.CFDMImplementation.initialise_TiePointIndex + ~cfdm.CFDMImplementation.initialise_ZarrArray + ~cfdm.CFDMImplementation.is_climatology + ~cfdm.CFDMImplementation.is_domain + ~cfdm.CFDMImplementation.is_field + ~cfdm.CFDMImplementation.is_geometry + ~cfdm.CFDMImplementation.is_masked + ~cfdm.CFDMImplementation.nc_get_dataset_chunksizes + ~cfdm.CFDMImplementation.nc_get_dataset_shards + ~cfdm.CFDMImplementation.nc_get_datum_variable + ~cfdm.CFDMImplementation.nc_get_dimension + ~cfdm.CFDMImplementation.nc_get_external + ~cfdm.CFDMImplementation.nc_get_geometry_variable + ~cfdm.CFDMImplementation.nc_get_global_attributes + ~cfdm.CFDMImplementation.nc_get_group_attributes + ~cfdm.CFDMImplementation.nc_get_hdf5_chunksizes + ~cfdm.CFDMImplementation.nc_get_sample_dimension + ~cfdm.CFDMImplementation.nc_get_variable + ~cfdm.CFDMImplementation.nc_get_variable_groups + ~cfdm.CFDMImplementation.nc_is_unlimited_axis + ~cfdm.CFDMImplementation.nc_set_dataset_chunksizes + ~cfdm.CFDMImplementation.nc_set_dataset_shards + ~cfdm.CFDMImplementation.nc_set_datum_variable + ~cfdm.CFDMImplementation.nc_set_dimension + ~cfdm.CFDMImplementation.nc_set_external + ~cfdm.CFDMImplementation.nc_set_geometry_variable + ~cfdm.CFDMImplementation.nc_set_global_attributes + ~cfdm.CFDMImplementation.nc_set_group_attributes + ~cfdm.CFDMImplementation.nc_set_hdf5_chunksizes + ~cfdm.CFDMImplementation.nc_set_instance_dimension + ~cfdm.CFDMImplementation.nc_set_interpolation_subarea_dimension + ~cfdm.CFDMImplementation.nc_set_node_coordinate_variable + ~cfdm.CFDMImplementation.nc_set_sample_dimension + ~cfdm.CFDMImplementation.nc_set_subsampled_dimension + ~cfdm.CFDMImplementation.nc_set_unlimited_axis + ~cfdm.CFDMImplementation.nc_set_variable + ~cfdm.CFDMImplementation.parameters + ~cfdm.CFDMImplementation.set_auxiliary_coordinate + ~cfdm.CFDMImplementation.set_bounds + ~cfdm.CFDMImplementation.set_cell_connectivity + ~cfdm.CFDMImplementation.set_cell_measure + ~cfdm.CFDMImplementation.set_cell_method + ~cfdm.CFDMImplementation.set_cell_method_axes + ~cfdm.CFDMImplementation.set_cell_method_method + ~cfdm.CFDMImplementation.set_class + ~cfdm.CFDMImplementation.set_climatology + ~cfdm.CFDMImplementation.set_construct + ~cfdm.CFDMImplementation.set_coordinate_conversion + ~cfdm.CFDMImplementation.set_coordinate_reference + ~cfdm.CFDMImplementation.set_coordinate_reference_coordinate + ~cfdm.CFDMImplementation.set_coordinate_reference_coordinates + ~cfdm.CFDMImplementation.set_data + ~cfdm.CFDMImplementation.set_dataset_compliance + ~cfdm.CFDMImplementation.set_datum + ~cfdm.CFDMImplementation.set_dependent_tie_points + ~cfdm.CFDMImplementation.set_dimension_coordinate + ~cfdm.CFDMImplementation.set_domain_ancillary + ~cfdm.CFDMImplementation.set_domain_axis + ~cfdm.CFDMImplementation.set_domain_topology + ~cfdm.CFDMImplementation.set_field_ancillary + ~cfdm.CFDMImplementation.set_geometry + ~cfdm.CFDMImplementation.set_inherited_properties + ~cfdm.CFDMImplementation.set_interior_ring + ~cfdm.CFDMImplementation.set_interpolation + ~cfdm.CFDMImplementation.set_node_count_properties + ~cfdm.CFDMImplementation.set_original_filenames + ~cfdm.CFDMImplementation.set_parameter + ~cfdm.CFDMImplementation.set_part_node_count_properties + ~cfdm.CFDMImplementation.set_properties + ~cfdm.CFDMImplementation.set_quantization + ~cfdm.CFDMImplementation.squeeze + ~cfdm.CFDMImplementation.unsqueeze diff --git a/docs/source/class/cfdm.CellConnectivityArray.rst b/docs/source/class/cfdm.CellConnectivityArray.rst new file mode 100644 index 000000000..e90e7758e --- /dev/null +++ b/docs/source/class/cfdm.CellConnectivityArray.rst @@ -0,0 +1,49 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.CellConnectivityArray +========================== + +---- + +.. autoclass:: cfdm.CellConnectivityArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.CellConnectivityArray.Units + ~cfdm.CellConnectivityArray.array + ~cfdm.CellConnectivityArray.astype + ~cfdm.CellConnectivityArray.compressed_array + ~cfdm.CellConnectivityArray.compressed_dimensions + ~cfdm.CellConnectivityArray.conformed_data + ~cfdm.CellConnectivityArray.copy + ~cfdm.CellConnectivityArray.dtype + ~cfdm.CellConnectivityArray.get_Subarray + ~cfdm.CellConnectivityArray.get_attributes + ~cfdm.CellConnectivityArray.get_calendar + ~cfdm.CellConnectivityArray.get_cell_dimension + ~cfdm.CellConnectivityArray.get_compressed_axes + ~cfdm.CellConnectivityArray.get_compressed_dimension + ~cfdm.CellConnectivityArray.get_compression_type + ~cfdm.CellConnectivityArray.get_filename + ~cfdm.CellConnectivityArray.get_start_index + ~cfdm.CellConnectivityArray.get_units + ~cfdm.CellConnectivityArray.ndim + ~cfdm.CellConnectivityArray.shape + ~cfdm.CellConnectivityArray.size + ~cfdm.CellConnectivityArray.source + ~cfdm.CellConnectivityArray.subarray_parameters + ~cfdm.CellConnectivityArray.subarray_shapes + ~cfdm.CellConnectivityArray.subarrays + ~cfdm.CellConnectivityArray.to_dask_array + ~cfdm.CellConnectivityArray.to_memory diff --git a/docs/source/class/cfdm.CellConnectivitySubarray.rst b/docs/source/class/cfdm.CellConnectivitySubarray.rst new file mode 100644 index 000000000..1401121ce --- /dev/null +++ b/docs/source/class/cfdm.CellConnectivitySubarray.rst @@ -0,0 +1,40 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.CellConnectivitySubarray +============================= + +---- + +.. autoclass:: cfdm.CellConnectivitySubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.CellConnectivitySubarray.Units + ~cfdm.CellConnectivitySubarray.array + ~cfdm.CellConnectivitySubarray.astype + ~cfdm.CellConnectivitySubarray.cell_dimension + ~cfdm.CellConnectivitySubarray.compressed_dimensions + ~cfdm.CellConnectivitySubarray.copy + ~cfdm.CellConnectivitySubarray.data + ~cfdm.CellConnectivitySubarray.dtype + ~cfdm.CellConnectivitySubarray.get_attributes + ~cfdm.CellConnectivitySubarray.get_calendar + ~cfdm.CellConnectivitySubarray.get_compression_type + ~cfdm.CellConnectivitySubarray.get_filename + ~cfdm.CellConnectivitySubarray.get_units + ~cfdm.CellConnectivitySubarray.indices + ~cfdm.CellConnectivitySubarray.ndim + ~cfdm.CellConnectivitySubarray.shape + ~cfdm.CellConnectivitySubarray.size + ~cfdm.CellConnectivitySubarray.start_index diff --git a/docs/source/class/cfdm.Container.rst b/docs/source/class/cfdm.Container.rst new file mode 100644 index 000000000..367825c54 --- /dev/null +++ b/docs/source/class/cfdm.Container.rst @@ -0,0 +1,23 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.TODO +========== + +---- + +.. autoclass:: cfdm.Container + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.Container.copy diff --git a/docs/source/class/cfdm.FullArray.rst b/docs/source/class/cfdm.FullArray.rst new file mode 100644 index 000000000..1ad5122e1 --- /dev/null +++ b/docs/source/class/cfdm.FullArray.rst @@ -0,0 +1,40 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.FullArray +============== + +---- + +.. autoclass:: cfdm.FullArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.FullArray.Units + ~cfdm.FullArray.array + ~cfdm.FullArray.astype + ~cfdm.FullArray.copy + ~cfdm.FullArray.dtype + ~cfdm.FullArray.get_attributes + ~cfdm.FullArray.get_calendar + ~cfdm.FullArray.get_compression_type + ~cfdm.FullArray.get_full_value + ~cfdm.FullArray.get_units + ~cfdm.FullArray.index + ~cfdm.FullArray.is_subspace + ~cfdm.FullArray.ndim + ~cfdm.FullArray.original_shape + ~cfdm.FullArray.reference_shape + ~cfdm.FullArray.set_full_value + ~cfdm.FullArray.shape + ~cfdm.FullArray.size diff --git a/docs/source/class/cfdm.GatheredSubarray.rst b/docs/source/class/cfdm.GatheredSubarray.rst new file mode 100644 index 000000000..89bddb634 --- /dev/null +++ b/docs/source/class/cfdm.GatheredSubarray.rst @@ -0,0 +1,39 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.GatheredSubarray +===================== + +---- + +.. autoclass:: cfdm.GatheredSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.GatheredSubarray.Units + ~cfdm.GatheredSubarray.array + ~cfdm.GatheredSubarray.astype + ~cfdm.GatheredSubarray.compressed_dimensions + ~cfdm.GatheredSubarray.copy + ~cfdm.GatheredSubarray.data + ~cfdm.GatheredSubarray.dtype + ~cfdm.GatheredSubarray.get_attributes + ~cfdm.GatheredSubarray.get_calendar + ~cfdm.GatheredSubarray.get_compression_type + ~cfdm.GatheredSubarray.get_filename + ~cfdm.GatheredSubarray.get_units + ~cfdm.GatheredSubarray.indices + ~cfdm.GatheredSubarray.ndim + ~cfdm.GatheredSubarray.shape + ~cfdm.GatheredSubarray.size + ~cfdm.GatheredSubarray.uncompressed_indices diff --git a/docs/source/class/cfdm.Implementation.rst b/docs/source/class/cfdm.Implementation.rst new file mode 100644 index 000000000..4da12ec36 --- /dev/null +++ b/docs/source/class/cfdm.Implementation.rst @@ -0,0 +1,27 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.Implementation +=================== + +---- + +.. autoclass:: cfdm.Implementation + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.Implementation.classes + ~cfdm.Implementation.copy + ~cfdm.Implementation.get_cf_version + ~cfdm.Implementation.get_class + ~cfdm.Implementation.set_class diff --git a/docs/source/class/cfdm.InterpolationParameter.rst b/docs/source/class/cfdm.InterpolationParameter.rst new file mode 100644 index 000000000..d9e6e6cf3 --- /dev/null +++ b/docs/source/class/cfdm.InterpolationParameter.rst @@ -0,0 +1,75 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.InterpolationParameter +=========================== + +---- + +.. autoclass:: cfdm.InterpolationParameter + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.InterpolationParameter.apply_masking + ~cfdm.InterpolationParameter.array + ~cfdm.InterpolationParameter.clear_properties + ~cfdm.InterpolationParameter.concatenate + ~cfdm.InterpolationParameter.copy + ~cfdm.InterpolationParameter.creation_commands + ~cfdm.InterpolationParameter.data + ~cfdm.InterpolationParameter.datetime_array + ~cfdm.InterpolationParameter.del_data + ~cfdm.InterpolationParameter.del_properties + ~cfdm.InterpolationParameter.del_property + ~cfdm.InterpolationParameter.dtype + ~cfdm.InterpolationParameter.dump + ~cfdm.InterpolationParameter.equals + ~cfdm.InterpolationParameter.file_directories + ~cfdm.InterpolationParameter.get_data + ~cfdm.InterpolationParameter.get_filenames + ~cfdm.InterpolationParameter.get_original_filenames + ~cfdm.InterpolationParameter.get_property + ~cfdm.InterpolationParameter.get_quantization + ~cfdm.InterpolationParameter.get_quantize_on_write + ~cfdm.InterpolationParameter.has_bounds + ~cfdm.InterpolationParameter.has_data + ~cfdm.InterpolationParameter.has_property + ~cfdm.InterpolationParameter.identities + ~cfdm.InterpolationParameter.identity + ~cfdm.InterpolationParameter.insert_dimension + ~cfdm.InterpolationParameter.nc_clear_dataset_chunksizes + ~cfdm.InterpolationParameter.nc_clear_hdf5_chunksizes + ~cfdm.InterpolationParameter.nc_clear_variable_groups + ~cfdm.InterpolationParameter.nc_dataset_chunksizes + ~cfdm.InterpolationParameter.nc_del_variable + ~cfdm.InterpolationParameter.nc_get_variable + ~cfdm.InterpolationParameter.nc_has_variable + ~cfdm.InterpolationParameter.nc_hdf5_chunksizes + ~cfdm.InterpolationParameter.nc_set_dataset_chunksizes + ~cfdm.InterpolationParameter.nc_set_hdf5_chunksizes + ~cfdm.InterpolationParameter.nc_set_variable + ~cfdm.InterpolationParameter.nc_set_variable_groups + ~cfdm.InterpolationParameter.nc_variable_groups + ~cfdm.InterpolationParameter.ndim + ~cfdm.InterpolationParameter.persist + ~cfdm.InterpolationParameter.properties + ~cfdm.InterpolationParameter.replace_directory + ~cfdm.InterpolationParameter.set_data + ~cfdm.InterpolationParameter.set_properties + ~cfdm.InterpolationParameter.set_property + ~cfdm.InterpolationParameter.shape + ~cfdm.InterpolationParameter.size + ~cfdm.InterpolationParameter.squeeze + ~cfdm.InterpolationParameter.to_memory + ~cfdm.InterpolationParameter.transpose + ~cfdm.InterpolationParameter.uncompress diff --git a/docs/source/class/cfdm.InterpolationSubarray.rst b/docs/source/class/cfdm.InterpolationSubarray.rst new file mode 100644 index 000000000..ec719c385 --- /dev/null +++ b/docs/source/class/cfdm.InterpolationSubarray.rst @@ -0,0 +1,44 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.InterpolationSubarray +========================== + +---- + +.. autoclass:: cfdm.InterpolationSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.InterpolationSubarray.Units + ~cfdm.InterpolationSubarray.array + ~cfdm.InterpolationSubarray.astype + ~cfdm.InterpolationSubarray.bounds + ~cfdm.InterpolationSubarray.compressed_dimensions + ~cfdm.InterpolationSubarray.copy + ~cfdm.InterpolationSubarray.data + ~cfdm.InterpolationSubarray.dependent_tie_points + ~cfdm.InterpolationSubarray.dtype + ~cfdm.InterpolationSubarray.first + ~cfdm.InterpolationSubarray.get_attributes + ~cfdm.InterpolationSubarray.get_calendar + ~cfdm.InterpolationSubarray.get_compression_type + ~cfdm.InterpolationSubarray.get_filename + ~cfdm.InterpolationSubarray.get_interpolation_description + ~cfdm.InterpolationSubarray.get_units + ~cfdm.InterpolationSubarray.indices + ~cfdm.InterpolationSubarray.ndim + ~cfdm.InterpolationSubarray.parameters + ~cfdm.InterpolationSubarray.shape + ~cfdm.InterpolationSubarray.size + ~cfdm.InterpolationSubarray.subarea_indices diff --git a/docs/source/class/cfdm.LinearSubarray.rst b/docs/source/class/cfdm.LinearSubarray.rst new file mode 100644 index 000000000..5027c8d1b --- /dev/null +++ b/docs/source/class/cfdm.LinearSubarray.rst @@ -0,0 +1,44 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.LinearSubarray +=================== + +---- + +.. autoclass:: cfdm.LinearSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.LinearSubarray.Units + ~cfdm.LinearSubarray.array + ~cfdm.LinearSubarray.astype + ~cfdm.LinearSubarray.bounds + ~cfdm.LinearSubarray.compressed_dimensions + ~cfdm.LinearSubarray.copy + ~cfdm.LinearSubarray.data + ~cfdm.LinearSubarray.dependent_tie_points + ~cfdm.LinearSubarray.dtype + ~cfdm.LinearSubarray.first + ~cfdm.LinearSubarray.get_attributes + ~cfdm.LinearSubarray.get_calendar + ~cfdm.LinearSubarray.get_compression_type + ~cfdm.LinearSubarray.get_filename + ~cfdm.LinearSubarray.get_interpolation_description + ~cfdm.LinearSubarray.get_units + ~cfdm.LinearSubarray.indices + ~cfdm.LinearSubarray.ndim + ~cfdm.LinearSubarray.parameters + ~cfdm.LinearSubarray.shape + ~cfdm.LinearSubarray.size + ~cfdm.LinearSubarray.subarea_indices diff --git a/docs/source/class/cfdm.NetCDFArray.rst b/docs/source/class/cfdm.NetCDFArray.rst new file mode 100644 index 000000000..80bff4bb4 --- /dev/null +++ b/docs/source/class/cfdm.NetCDFArray.rst @@ -0,0 +1,23 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.TODO +========== + +---- + +.. autoclass:: cfdm.TODO + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.TODO diff --git a/docs/source/class/cfdm.NodeCountProperties.rst b/docs/source/class/cfdm.NodeCountProperties.rst new file mode 100644 index 000000000..4b3f8449c --- /dev/null +++ b/docs/source/class/cfdm.NodeCountProperties.rst @@ -0,0 +1,46 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.NodeCountProperties +======================== + +---- + +.. autoclass:: cfdm.NodeCountProperties + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.NodeCountProperties.clear_properties + ~cfdm.NodeCountProperties.copy + ~cfdm.NodeCountProperties.creation_commands + ~cfdm.NodeCountProperties.del_properties + ~cfdm.NodeCountProperties.del_property + ~cfdm.NodeCountProperties.dump + ~cfdm.NodeCountProperties.equals + ~cfdm.NodeCountProperties.get_original_filenames + ~cfdm.NodeCountProperties.get_property + ~cfdm.NodeCountProperties.has_bounds + ~cfdm.NodeCountProperties.has_data + ~cfdm.NodeCountProperties.has_property + ~cfdm.NodeCountProperties.identities + ~cfdm.NodeCountProperties.identity + ~cfdm.NodeCountProperties.nc_clear_variable_groups + ~cfdm.NodeCountProperties.nc_del_variable + ~cfdm.NodeCountProperties.nc_get_variable + ~cfdm.NodeCountProperties.nc_has_variable + ~cfdm.NodeCountProperties.nc_set_variable + ~cfdm.NodeCountProperties.nc_set_variable_groups + ~cfdm.NodeCountProperties.nc_variable_groups + ~cfdm.NodeCountProperties.properties + ~cfdm.NodeCountProperties.set_properties + ~cfdm.NodeCountProperties.set_property diff --git a/docs/source/class/cfdm.NumpyArray.rst b/docs/source/class/cfdm.NumpyArray.rst new file mode 100644 index 000000000..80bff4bb4 --- /dev/null +++ b/docs/source/class/cfdm.NumpyArray.rst @@ -0,0 +1,23 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.TODO +========== + +---- + +.. autoclass:: cfdm.TODO + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.TODO diff --git a/docs/source/class/cfdm.PartNodeCountProperties.rst b/docs/source/class/cfdm.PartNodeCountProperties.rst new file mode 100644 index 000000000..cef636904 --- /dev/null +++ b/docs/source/class/cfdm.PartNodeCountProperties.rst @@ -0,0 +1,53 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.PartNodeCountProperties +============================ + +---- + +.. autoclass:: cfdm.PartNodeCountProperties + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.PartNodeCountProperties.clear_properties + ~cfdm.PartNodeCountProperties.copy + ~cfdm.PartNodeCountProperties.creation_commands + ~cfdm.PartNodeCountProperties.del_properties + ~cfdm.PartNodeCountProperties.del_property + ~cfdm.PartNodeCountProperties.dump + ~cfdm.PartNodeCountProperties.equals + ~cfdm.PartNodeCountProperties.get_original_filenames + ~cfdm.PartNodeCountProperties.get_property + ~cfdm.PartNodeCountProperties.has_bounds + ~cfdm.PartNodeCountProperties.has_data + ~cfdm.PartNodeCountProperties.has_property + ~cfdm.PartNodeCountProperties.identities + ~cfdm.PartNodeCountProperties.identity + ~cfdm.PartNodeCountProperties.nc_clear_dimension_groups + ~cfdm.PartNodeCountProperties.nc_clear_variable_groups + ~cfdm.PartNodeCountProperties.nc_del_dimension + ~cfdm.PartNodeCountProperties.nc_del_variable + ~cfdm.PartNodeCountProperties.nc_dimension_groups + ~cfdm.PartNodeCountProperties.nc_get_dimension + ~cfdm.PartNodeCountProperties.nc_get_variable + ~cfdm.PartNodeCountProperties.nc_has_dimension + ~cfdm.PartNodeCountProperties.nc_has_variable + ~cfdm.PartNodeCountProperties.nc_set_dimension + ~cfdm.PartNodeCountProperties.nc_set_dimension_groups + ~cfdm.PartNodeCountProperties.nc_set_variable + ~cfdm.PartNodeCountProperties.nc_set_variable_groups + ~cfdm.PartNodeCountProperties.nc_variable_groups + ~cfdm.PartNodeCountProperties.properties + ~cfdm.PartNodeCountProperties.set_properties + ~cfdm.PartNodeCountProperties.set_property diff --git a/docs/source/class/cfdm.PointTopologyArray.rst b/docs/source/class/cfdm.PointTopologyArray.rst new file mode 100644 index 000000000..a6d9a510c --- /dev/null +++ b/docs/source/class/cfdm.PointTopologyArray.rst @@ -0,0 +1,49 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.PointTopologyArray +======================= + +---- + +.. autoclass:: cfdm.PointTopologyArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.PointTopologyArray.Units + ~cfdm.PointTopologyArray.array + ~cfdm.PointTopologyArray.astype + ~cfdm.PointTopologyArray.compressed_array + ~cfdm.PointTopologyArray.compressed_dimensions + ~cfdm.PointTopologyArray.conformed_data + ~cfdm.PointTopologyArray.copy + ~cfdm.PointTopologyArray.dtype + ~cfdm.PointTopologyArray.get_Subarray + ~cfdm.PointTopologyArray.get_attributes + ~cfdm.PointTopologyArray.get_calendar + ~cfdm.PointTopologyArray.get_cell_dimension + ~cfdm.PointTopologyArray.get_compressed_axes + ~cfdm.PointTopologyArray.get_compressed_dimension + ~cfdm.PointTopologyArray.get_compression_type + ~cfdm.PointTopologyArray.get_filename + ~cfdm.PointTopologyArray.get_start_index + ~cfdm.PointTopologyArray.get_units + ~cfdm.PointTopologyArray.ndim + ~cfdm.PointTopologyArray.shape + ~cfdm.PointTopologyArray.size + ~cfdm.PointTopologyArray.source + ~cfdm.PointTopologyArray.subarray_parameters + ~cfdm.PointTopologyArray.subarray_shapes + ~cfdm.PointTopologyArray.subarrays + ~cfdm.PointTopologyArray.to_dask_array + ~cfdm.PointTopologyArray.to_memory diff --git a/docs/source/class/cfdm.PyfiveArray.rst b/docs/source/class/cfdm.PyfiveArray.rst new file mode 100644 index 000000000..13ff00b31 --- /dev/null +++ b/docs/source/class/cfdm.PyfiveArray.rst @@ -0,0 +1,54 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.PyfiveArray +================ + +---- + +.. autoclass:: cfdm.PyfiveArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.PyfiveArray.Units + ~cfdm.PyfiveArray.array + ~cfdm.PyfiveArray.astype + ~cfdm.PyfiveArray.close + ~cfdm.PyfiveArray.copy + ~cfdm.PyfiveArray.dtype + ~cfdm.PyfiveArray.file_directory + ~cfdm.PyfiveArray.get_address + ~cfdm.PyfiveArray.get_attributes + ~cfdm.PyfiveArray.get_calendar + ~cfdm.PyfiveArray.get_compression_type + ~cfdm.PyfiveArray.get_filename + ~cfdm.PyfiveArray.get_groups + ~cfdm.PyfiveArray.get_mask + ~cfdm.PyfiveArray.get_missing_values + ~cfdm.PyfiveArray.get_storage_options + ~cfdm.PyfiveArray.get_storage_protocol + ~cfdm.PyfiveArray.get_units + ~cfdm.PyfiveArray.get_unpack + ~cfdm.PyfiveArray.get_variable + ~cfdm.PyfiveArray.has_remote_storage_protocol + ~cfdm.PyfiveArray.index + ~cfdm.PyfiveArray.is_subspace + ~cfdm.PyfiveArray.ndim + ~cfdm.PyfiveArray.open + ~cfdm.PyfiveArray.original_shape + ~cfdm.PyfiveArray.reference_shape + ~cfdm.PyfiveArray.replace_directory + ~cfdm.PyfiveArray.replace_filename + ~cfdm.PyfiveArray.shape + ~cfdm.PyfiveArray.size + ~cfdm.PyfiveArray.to_memory diff --git a/docs/source/class/cfdm.QuadraticLatitudeLongitudeSubarray.rst b/docs/source/class/cfdm.QuadraticLatitudeLongitudeSubarray.rst new file mode 100644 index 000000000..23c05b801 --- /dev/null +++ b/docs/source/class/cfdm.QuadraticLatitudeLongitudeSubarray.rst @@ -0,0 +1,44 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.QuadraticLatitudeLongitudeSubarray +======================================= + +---- + +.. autoclass:: cfdm.QuadraticLatitudeLongitudeSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.QuadraticLatitudeLongitudeSubarray.Units + ~cfdm.QuadraticLatitudeLongitudeSubarray.array + ~cfdm.QuadraticLatitudeLongitudeSubarray.astype + ~cfdm.QuadraticLatitudeLongitudeSubarray.bounds + ~cfdm.QuadraticLatitudeLongitudeSubarray.compressed_dimensions + ~cfdm.QuadraticLatitudeLongitudeSubarray.copy + ~cfdm.QuadraticLatitudeLongitudeSubarray.data + ~cfdm.QuadraticLatitudeLongitudeSubarray.dependent_tie_points + ~cfdm.QuadraticLatitudeLongitudeSubarray.dtype + ~cfdm.QuadraticLatitudeLongitudeSubarray.first + ~cfdm.QuadraticLatitudeLongitudeSubarray.get_attributes + ~cfdm.QuadraticLatitudeLongitudeSubarray.get_calendar + ~cfdm.QuadraticLatitudeLongitudeSubarray.get_compression_type + ~cfdm.QuadraticLatitudeLongitudeSubarray.get_filename + ~cfdm.QuadraticLatitudeLongitudeSubarray.get_interpolation_description + ~cfdm.QuadraticLatitudeLongitudeSubarray.get_units + ~cfdm.QuadraticLatitudeLongitudeSubarray.indices + ~cfdm.QuadraticLatitudeLongitudeSubarray.ndim + ~cfdm.QuadraticLatitudeLongitudeSubarray.parameters + ~cfdm.QuadraticLatitudeLongitudeSubarray.shape + ~cfdm.QuadraticLatitudeLongitudeSubarray.size + ~cfdm.QuadraticLatitudeLongitudeSubarray.subarea_indices diff --git a/docs/source/class/cfdm.QuadraticSubarray.rst b/docs/source/class/cfdm.QuadraticSubarray.rst new file mode 100644 index 000000000..5fe9c8521 --- /dev/null +++ b/docs/source/class/cfdm.QuadraticSubarray.rst @@ -0,0 +1,44 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.QuadraticSubarray +====================== + +---- + +.. autoclass:: cfdm.QuadraticSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.QuadraticSubarray.Units + ~cfdm.QuadraticSubarray.array + ~cfdm.QuadraticSubarray.astype + ~cfdm.QuadraticSubarray.bounds + ~cfdm.QuadraticSubarray.compressed_dimensions + ~cfdm.QuadraticSubarray.copy + ~cfdm.QuadraticSubarray.data + ~cfdm.QuadraticSubarray.dependent_tie_points + ~cfdm.QuadraticSubarray.dtype + ~cfdm.QuadraticSubarray.first + ~cfdm.QuadraticSubarray.get_attributes + ~cfdm.QuadraticSubarray.get_calendar + ~cfdm.QuadraticSubarray.get_compression_type + ~cfdm.QuadraticSubarray.get_filename + ~cfdm.QuadraticSubarray.get_interpolation_description + ~cfdm.QuadraticSubarray.get_units + ~cfdm.QuadraticSubarray.indices + ~cfdm.QuadraticSubarray.ndim + ~cfdm.QuadraticSubarray.parameters + ~cfdm.QuadraticSubarray.shape + ~cfdm.QuadraticSubarray.size + ~cfdm.QuadraticSubarray.subarea_indices diff --git a/docs/source/class/cfdm.RaggedArray.rst b/docs/source/class/cfdm.RaggedArray.rst new file mode 100644 index 000000000..96fc1efaa --- /dev/null +++ b/docs/source/class/cfdm.RaggedArray.rst @@ -0,0 +1,48 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.RaggedArray +================ + +---- + +.. autoclass:: cfdm.RaggedArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.RaggedArray.Units + ~cfdm.RaggedArray.array + ~cfdm.RaggedArray.astype + ~cfdm.RaggedArray.compressed_array + ~cfdm.RaggedArray.compressed_dimensions + ~cfdm.RaggedArray.conformed_data + ~cfdm.RaggedArray.copy + ~cfdm.RaggedArray.dtype + ~cfdm.RaggedArray.get_Subarray + ~cfdm.RaggedArray.get_attributes + ~cfdm.RaggedArray.get_calendar + ~cfdm.RaggedArray.get_compressed_axes + ~cfdm.RaggedArray.get_compressed_dimension + ~cfdm.RaggedArray.get_compression_type + ~cfdm.RaggedArray.get_count + ~cfdm.RaggedArray.get_filename + ~cfdm.RaggedArray.get_index + ~cfdm.RaggedArray.get_units + ~cfdm.RaggedArray.ndim + ~cfdm.RaggedArray.shape + ~cfdm.RaggedArray.size + ~cfdm.RaggedArray.source + ~cfdm.RaggedArray.subarray_parameters + ~cfdm.RaggedArray.subarray_shapes + ~cfdm.RaggedArray.subarrays + ~cfdm.RaggedArray.to_memory diff --git a/docs/source/class/cfdm.RaggedSubarray.rst b/docs/source/class/cfdm.RaggedSubarray.rst new file mode 100644 index 000000000..ebff5852e --- /dev/null +++ b/docs/source/class/cfdm.RaggedSubarray.rst @@ -0,0 +1,38 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.RaggedSubarray +=================== + +---- + +.. autoclass:: cfdm.RaggedSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.RaggedSubarray.Units + ~cfdm.RaggedSubarray.array + ~cfdm.RaggedSubarray.astype + ~cfdm.RaggedSubarray.compressed_dimensions + ~cfdm.RaggedSubarray.copy + ~cfdm.RaggedSubarray.data + ~cfdm.RaggedSubarray.dtype + ~cfdm.RaggedSubarray.get_attributes + ~cfdm.RaggedSubarray.get_calendar + ~cfdm.RaggedSubarray.get_compression_type + ~cfdm.RaggedSubarray.get_filename + ~cfdm.RaggedSubarray.get_units + ~cfdm.RaggedSubarray.indices + ~cfdm.RaggedSubarray.ndim + ~cfdm.RaggedSubarray.shape + ~cfdm.RaggedSubarray.size diff --git a/docs/source/class/cfdm.ScipyNetcdfFileArray.rst b/docs/source/class/cfdm.ScipyNetcdfFileArray.rst new file mode 100644 index 000000000..821b63f03 --- /dev/null +++ b/docs/source/class/cfdm.ScipyNetcdfFileArray.rst @@ -0,0 +1,53 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.ScipyNetcdfFileArray +========================= + +---- + +.. autoclass:: cfdm.ScipyNetcdfFileArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.ScipyNetcdfFileArray.Units + ~cfdm.ScipyNetcdfFileArray.array + ~cfdm.ScipyNetcdfFileArray.astype + ~cfdm.ScipyNetcdfFileArray.close + ~cfdm.ScipyNetcdfFileArray.copy + ~cfdm.ScipyNetcdfFileArray.dtype + ~cfdm.ScipyNetcdfFileArray.file_directory + ~cfdm.ScipyNetcdfFileArray.get_address + ~cfdm.ScipyNetcdfFileArray.get_attributes + ~cfdm.ScipyNetcdfFileArray.get_calendar + ~cfdm.ScipyNetcdfFileArray.get_compression_type + ~cfdm.ScipyNetcdfFileArray.get_filename + ~cfdm.ScipyNetcdfFileArray.get_mask + ~cfdm.ScipyNetcdfFileArray.get_missing_values + ~cfdm.ScipyNetcdfFileArray.get_storage_options + ~cfdm.ScipyNetcdfFileArray.get_storage_protocol + ~cfdm.ScipyNetcdfFileArray.get_units + ~cfdm.ScipyNetcdfFileArray.get_unpack + ~cfdm.ScipyNetcdfFileArray.get_variable + ~cfdm.ScipyNetcdfFileArray.has_remote_storage_protocol + ~cfdm.ScipyNetcdfFileArray.index + ~cfdm.ScipyNetcdfFileArray.is_subspace + ~cfdm.ScipyNetcdfFileArray.ndim + ~cfdm.ScipyNetcdfFileArray.open + ~cfdm.ScipyNetcdfFileArray.original_shape + ~cfdm.ScipyNetcdfFileArray.reference_shape + ~cfdm.ScipyNetcdfFileArray.replace_directory + ~cfdm.ScipyNetcdfFileArray.replace_filename + ~cfdm.ScipyNetcdfFileArray.shape + ~cfdm.ScipyNetcdfFileArray.size + ~cfdm.ScipyNetcdfFileArray.to_memory diff --git a/docs/source/class/cfdm.SparseArray.rst b/docs/source/class/cfdm.SparseArray.rst new file mode 100644 index 000000000..ebac0587b --- /dev/null +++ b/docs/source/class/cfdm.SparseArray.rst @@ -0,0 +1,36 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.SparseArray +================ + +---- + +.. autoclass:: cfdm.SparseArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.SparseArray.Units + ~cfdm.SparseArray.array + ~cfdm.SparseArray.astype + ~cfdm.SparseArray.copy + ~cfdm.SparseArray.dtype + ~cfdm.SparseArray.get_attributes + ~cfdm.SparseArray.get_calendar + ~cfdm.SparseArray.get_compression_type + ~cfdm.SparseArray.get_units + ~cfdm.SparseArray.ndim + ~cfdm.SparseArray.shape + ~cfdm.SparseArray.size + ~cfdm.SparseArray.sparse_array + ~cfdm.SparseArray.to_memory diff --git a/docs/source/class/cfdm.Subarray.rst b/docs/source/class/cfdm.Subarray.rst new file mode 100644 index 000000000..fa4c91795 --- /dev/null +++ b/docs/source/class/cfdm.Subarray.rst @@ -0,0 +1,38 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.Subarray +============= + +---- + +.. autoclass:: cfdm.Subarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.Subarray.Units + ~cfdm.Subarray.array + ~cfdm.Subarray.astype + ~cfdm.Subarray.compressed_dimensions + ~cfdm.Subarray.copy + ~cfdm.Subarray.data + ~cfdm.Subarray.dtype + ~cfdm.Subarray.get_attributes + ~cfdm.Subarray.get_calendar + ~cfdm.Subarray.get_compression_type + ~cfdm.Subarray.get_filename + ~cfdm.Subarray.get_units + ~cfdm.Subarray.indices + ~cfdm.Subarray.ndim + ~cfdm.Subarray.shape + ~cfdm.Subarray.size diff --git a/docs/source/class/cfdm.SubsampledArray.rst b/docs/source/class/cfdm.SubsampledArray.rst new file mode 100644 index 000000000..d4d813fc8 --- /dev/null +++ b/docs/source/class/cfdm.SubsampledArray.rst @@ -0,0 +1,61 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.SubsampledArray +==================== + +---- + +.. autoclass:: cfdm.SubsampledArray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.SubsampledArray.Units + ~cfdm.SubsampledArray.array + ~cfdm.SubsampledArray.astype + ~cfdm.SubsampledArray.bounds + ~cfdm.SubsampledArray.compressed_array + ~cfdm.SubsampledArray.compressed_dimensions + ~cfdm.SubsampledArray.conformed_data + ~cfdm.SubsampledArray.copy + ~cfdm.SubsampledArray.dtype + ~cfdm.SubsampledArray.get_Subarray + ~cfdm.SubsampledArray.get_attributes + ~cfdm.SubsampledArray.get_calendar + ~cfdm.SubsampledArray.get_compressed_axes + ~cfdm.SubsampledArray.get_compressed_dimension + ~cfdm.SubsampledArray.get_compression_type + ~cfdm.SubsampledArray.get_computational_precision + ~cfdm.SubsampledArray.get_dependent_tie_point_dimensions + ~cfdm.SubsampledArray.get_dependent_tie_points + ~cfdm.SubsampledArray.get_filename + ~cfdm.SubsampledArray.get_interpolation_description + ~cfdm.SubsampledArray.get_interpolation_name + ~cfdm.SubsampledArray.get_parameter_dimensions + ~cfdm.SubsampledArray.get_parameters + ~cfdm.SubsampledArray.get_tie_point_indices + ~cfdm.SubsampledArray.get_units + ~cfdm.SubsampledArray.ndim + ~cfdm.SubsampledArray.set_dependent_tie_point_dimensions + ~cfdm.SubsampledArray.set_dependent_tie_points + ~cfdm.SubsampledArray.set_parameter_dimensions + ~cfdm.SubsampledArray.set_parameters + ~cfdm.SubsampledArray.set_tie_point_indices + ~cfdm.SubsampledArray.shape + ~cfdm.SubsampledArray.size + ~cfdm.SubsampledArray.source + ~cfdm.SubsampledArray.subarray_parameters + ~cfdm.SubsampledArray.subarray_shapes + ~cfdm.SubsampledArray.subarrays + ~cfdm.SubsampledArray.to_dask_array + ~cfdm.SubsampledArray.to_memory diff --git a/docs/source/class/cfdm.SubsampledSubarray.rst b/docs/source/class/cfdm.SubsampledSubarray.rst new file mode 100644 index 000000000..949eb2c93 --- /dev/null +++ b/docs/source/class/cfdm.SubsampledSubarray.rst @@ -0,0 +1,44 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.SubsampledSubarray +======================= + +---- + +.. autoclass:: cfdm.SubsampledSubarray + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.SubsampledSubarray.Units + ~cfdm.SubsampledSubarray.array + ~cfdm.SubsampledSubarray.astype + ~cfdm.SubsampledSubarray.bounds + ~cfdm.SubsampledSubarray.compressed_dimensions + ~cfdm.SubsampledSubarray.copy + ~cfdm.SubsampledSubarray.data + ~cfdm.SubsampledSubarray.dependent_tie_points + ~cfdm.SubsampledSubarray.dtype + ~cfdm.SubsampledSubarray.first + ~cfdm.SubsampledSubarray.get_attributes + ~cfdm.SubsampledSubarray.get_calendar + ~cfdm.SubsampledSubarray.get_compression_type + ~cfdm.SubsampledSubarray.get_filename + ~cfdm.SubsampledSubarray.get_interpolation_description + ~cfdm.SubsampledSubarray.get_units + ~cfdm.SubsampledSubarray.indices + ~cfdm.SubsampledSubarray.ndim + ~cfdm.SubsampledSubarray.parameters + ~cfdm.SubsampledSubarray.shape + ~cfdm.SubsampledSubarray.size + ~cfdm.SubsampledSubarray.subarea_indices diff --git a/docs/source/class/cfdm.TiePointIndex.rst b/docs/source/class/cfdm.TiePointIndex.rst new file mode 100644 index 000000000..974a8a5c8 --- /dev/null +++ b/docs/source/class/cfdm.TiePointIndex.rst @@ -0,0 +1,89 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.TiePointIndex +================== + +---- + +.. autoclass:: cfdm.TiePointIndex + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.TiePointIndex.apply_masking + ~cfdm.TiePointIndex.array + ~cfdm.TiePointIndex.clear_properties + ~cfdm.TiePointIndex.concatenate + ~cfdm.TiePointIndex.copy + ~cfdm.TiePointIndex.creation_commands + ~cfdm.TiePointIndex.data + ~cfdm.TiePointIndex.datetime_array + ~cfdm.TiePointIndex.del_data + ~cfdm.TiePointIndex.del_properties + ~cfdm.TiePointIndex.del_property + ~cfdm.TiePointIndex.dtype + ~cfdm.TiePointIndex.dump + ~cfdm.TiePointIndex.equals + ~cfdm.TiePointIndex.file_directories + ~cfdm.TiePointIndex.get_data + ~cfdm.TiePointIndex.get_filenames + ~cfdm.TiePointIndex.get_original_filenames + ~cfdm.TiePointIndex.get_property + ~cfdm.TiePointIndex.get_quantization + ~cfdm.TiePointIndex.get_quantize_on_write + ~cfdm.TiePointIndex.has_bounds + ~cfdm.TiePointIndex.has_data + ~cfdm.TiePointIndex.has_property + ~cfdm.TiePointIndex.identities + ~cfdm.TiePointIndex.identity + ~cfdm.TiePointIndex.insert_dimension + ~cfdm.TiePointIndex.nc_clear_dataset_chunksizes + ~cfdm.TiePointIndex.nc_clear_hdf5_chunksizes + ~cfdm.TiePointIndex.nc_clear_interpolation_subarea_dimension_groups + ~cfdm.TiePointIndex.nc_clear_subsampled_dimension_groups + ~cfdm.TiePointIndex.nc_clear_variable_groups + ~cfdm.TiePointIndex.nc_dataset_chunksizes + ~cfdm.TiePointIndex.nc_del_interpolation_subarea_dimension + ~cfdm.TiePointIndex.nc_del_subsampled_dimension + ~cfdm.TiePointIndex.nc_del_variable + ~cfdm.TiePointIndex.nc_get_interpolation_subarea_dimension + ~cfdm.TiePointIndex.nc_get_subsampled_dimension + ~cfdm.TiePointIndex.nc_get_variable + ~cfdm.TiePointIndex.nc_has_interpolation_subarea_dimension + ~cfdm.TiePointIndex.nc_has_subsampled_dimension + ~cfdm.TiePointIndex.nc_has_variable + ~cfdm.TiePointIndex.nc_hdf5_chunksizes + ~cfdm.TiePointIndex.nc_interpolation_subarea_dimension_groups + ~cfdm.TiePointIndex.nc_set_dataset_chunksizes + ~cfdm.TiePointIndex.nc_set_hdf5_chunksizes + ~cfdm.TiePointIndex.nc_set_interpolation_subarea_dimension + ~cfdm.TiePointIndex.nc_set_interpolation_subarea_dimension_groups + ~cfdm.TiePointIndex.nc_set_subsampled_dimension + ~cfdm.TiePointIndex.nc_set_subsampled_dimension_groups + ~cfdm.TiePointIndex.nc_set_variable + ~cfdm.TiePointIndex.nc_set_variable_groups + ~cfdm.TiePointIndex.nc_subsampled_dimension_groups + ~cfdm.TiePointIndex.nc_variable_groups + ~cfdm.TiePointIndex.ndim + ~cfdm.TiePointIndex.persist + ~cfdm.TiePointIndex.properties + ~cfdm.TiePointIndex.replace_directory + ~cfdm.TiePointIndex.set_data + ~cfdm.TiePointIndex.set_properties + ~cfdm.TiePointIndex.set_property + ~cfdm.TiePointIndex.shape + ~cfdm.TiePointIndex.size + ~cfdm.TiePointIndex.squeeze + ~cfdm.TiePointIndex.to_memory + ~cfdm.TiePointIndex.transpose + ~cfdm.TiePointIndex.uncompress diff --git a/docs/source/class/cfdm.Units.rst b/docs/source/class/cfdm.Units.rst new file mode 100644 index 000000000..7e2dcdea1 --- /dev/null +++ b/docs/source/class/cfdm.Units.rst @@ -0,0 +1,19 @@ +cfdm.Units +========== + +.. currentmodule:: cfdm + +.. autoclass:: Units + :no-members: + + +.. rubric:: Methods + +.. autosummary:: + :toctree: + :nosignatures: + + ~cfdm.Units.__init__ + ~cfdm.Units.conform + + diff --git a/docs/source/class/cfdm.__init__.rst b/docs/source/class/cfdm.__init__.rst new file mode 100644 index 000000000..464f46a38 --- /dev/null +++ b/docs/source/class/cfdm.__init__.rst @@ -0,0 +1,7 @@ +cfdm.__init__ +============= + +.. currentmodule:: cfdm +.. default-role:: obj + +.. autofunction:: __init__ \ No newline at end of file diff --git a/docs/source/class/cfdm.bounds.rst b/docs/source/class/cfdm.bounds.rst new file mode 100644 index 000000000..221f2a2c6 --- /dev/null +++ b/docs/source/class/cfdm.bounds.rst @@ -0,0 +1,12 @@ +cfdm.bounds +=========== + +.. automodule:: cfdm.bounds + + + .. rubric:: Classes + + .. autosummary:: + + Bounds + \ No newline at end of file diff --git a/docs/source/class/cfdm.chunksize.rst b/docs/source/class/cfdm.chunksize.rst new file mode 100644 index 000000000..243f7f474 --- /dev/null +++ b/docs/source/class/cfdm.chunksize.rst @@ -0,0 +1,23 @@ +cfdm.chunksize +============== + +.. currentmodule:: cfdm + +.. autoclass:: chunksize + :no-members: + + + + + + + +.. rubric:: Methods + +.. autosummary:: + :toctree: + :nosignatures: + + __init__ + + diff --git a/docs/source/class/cfdm.constructs.rst b/docs/source/class/cfdm.constructs.rst new file mode 100644 index 000000000..7a60d9048 --- /dev/null +++ b/docs/source/class/cfdm.constructs.rst @@ -0,0 +1,12 @@ +cfdm.constructs +=============== + +.. automodule:: cfdm.constructs + + + .. rubric:: Classes + + .. autosummary:: + + Constructs + \ No newline at end of file diff --git a/docs/source/class/cfdm.core.Topology.rst b/docs/source/class/cfdm.core.Topology.rst new file mode 100644 index 000000000..8785beaca --- /dev/null +++ b/docs/source/class/cfdm.core.Topology.rst @@ -0,0 +1,41 @@ +.. currentmodule:: cfdm +.. default-role:: obj + +cfdm.core.Topology +================== + +---- + +.. autoclass:: cfdm.core.Topology + :no-members: + :no-inherited-members: + +Methods +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cfdm.core.Topology.clear_properties + ~cfdm.core.Topology.copy + ~cfdm.core.Topology.data + ~cfdm.core.Topology.del_data + ~cfdm.core.Topology.del_properties + ~cfdm.core.Topology.del_property + ~cfdm.core.Topology.dtype + ~cfdm.core.Topology.get_data + ~cfdm.core.Topology.get_property + ~cfdm.core.Topology.has_bounds + ~cfdm.core.Topology.has_data + ~cfdm.core.Topology.has_property + ~cfdm.core.Topology.ndim + ~cfdm.core.Topology.properties + ~cfdm.core.Topology.set_data + ~cfdm.core.Topology.set_properties + ~cfdm.core.Topology.set_property + ~cfdm.core.Topology.shape + ~cfdm.core.Topology.size diff --git a/docs/source/class/cfdm.core.__init__.rst b/docs/source/class/cfdm.core.__init__.rst new file mode 100644 index 000000000..e29859593 --- /dev/null +++ b/docs/source/class/cfdm.core.__init__.rst @@ -0,0 +1,6 @@ +cfdm.core.\_\_init\_\_ +====================== + +.. currentmodule:: cfdm.core + +.. autofunction:: __init__ diff --git a/docs/source/class/cfdm.core.bounds.rst b/docs/source/class/cfdm.core.bounds.rst new file mode 100644 index 000000000..2630b9a6f --- /dev/null +++ b/docs/source/class/cfdm.core.bounds.rst @@ -0,0 +1,12 @@ +cfdm.core.bounds +================ + +.. automodule:: cfdm.core.bounds + + + .. rubric:: Classes + + .. autosummary:: + + Bounds + \ No newline at end of file diff --git a/docs/source/class/cfdm.core.constructs.rst b/docs/source/class/cfdm.core.constructs.rst new file mode 100644 index 000000000..f054b668a --- /dev/null +++ b/docs/source/class/cfdm.core.constructs.rst @@ -0,0 +1,12 @@ +cfdm.core.constructs +==================== + +.. automodule:: cfdm.core.constructs + + + .. rubric:: Classes + + .. autosummary:: + + Constructs + \ No newline at end of file diff --git a/docs/source/class/cfdm.core.data.rst b/docs/source/class/cfdm.core.data.rst new file mode 100644 index 000000000..3474557ec --- /dev/null +++ b/docs/source/class/cfdm.core.data.rst @@ -0,0 +1,6 @@ +cfdm.core.data +============== + +.. automodule:: cfdm.core.data + + \ No newline at end of file diff --git a/docs/source/class/cfdm.core.datum.rst b/docs/source/class/cfdm.core.datum.rst new file mode 100644 index 000000000..cf5cb34e3 --- /dev/null +++ b/docs/source/class/cfdm.core.datum.rst @@ -0,0 +1,12 @@ +cfdm.core.datum +=============== + +.. automodule:: cfdm.core.datum + + + .. rubric:: Classes + + .. autosummary:: + + Datum + \ No newline at end of file diff --git a/docs/source/class/cfdm.core.domain.rst b/docs/source/class/cfdm.core.domain.rst new file mode 100644 index 000000000..d45308782 --- /dev/null +++ b/docs/source/class/cfdm.core.domain.rst @@ -0,0 +1,12 @@ +cfdm.core.domain +================ + +.. automodule:: cfdm.core.domain + + + .. rubric:: Classes + + .. autosummary:: + + Domain + \ No newline at end of file diff --git a/docs/source/class/cfdm.data.rst b/docs/source/class/cfdm.data.rst new file mode 100644 index 000000000..ef31fe677 --- /dev/null +++ b/docs/source/class/cfdm.data.rst @@ -0,0 +1,6 @@ +cfdm.data +========= + +.. automodule:: cfdm.data + + \ No newline at end of file diff --git a/docs/source/class/cfdm.datum.rst b/docs/source/class/cfdm.datum.rst new file mode 100644 index 000000000..b6df23d6b --- /dev/null +++ b/docs/source/class/cfdm.datum.rst @@ -0,0 +1,12 @@ +cfdm.datum +========== + +.. automodule:: cfdm.datum + + + .. rubric:: Classes + + .. autosummary:: + + Datum + \ No newline at end of file diff --git a/docs/source/class/cfdm.domain.rst b/docs/source/class/cfdm.domain.rst new file mode 100644 index 000000000..3893d863a --- /dev/null +++ b/docs/source/class/cfdm.domain.rst @@ -0,0 +1,12 @@ +cfdm.domain +=========== + +.. automodule:: cfdm.domain + + + .. rubric:: Classes + + .. autosummary:: + + Domain + \ No newline at end of file diff --git a/docs/source/class/cfdm.index.rst b/docs/source/class/cfdm.index.rst new file mode 100644 index 000000000..295a9cf93 --- /dev/null +++ b/docs/source/class/cfdm.index.rst @@ -0,0 +1,12 @@ +cfdm.index +========== + +.. automodule:: cfdm.index + + + .. rubric:: Classes + + .. autosummary:: + + Index + \ No newline at end of file diff --git a/docs/source/class_core.rst b/docs/source/class_core.rst index 4b631da08..1f64a0f53 100644 --- a/docs/source/class_core.rst +++ b/docs/source/class_core.rst @@ -96,6 +96,7 @@ construct components. cfdm.core.Coordinate cfdm.core.Parameters cfdm.core.ParametersDomainAncillaries + cfdm.core.Topology Miscellaneous ------------- @@ -105,4 +106,3 @@ Miscellaneous :toctree: class/ cfdm.core.DocstringRewriteMeta -