From ba0fbf4c3deb3f4fec6df486bbeea71bd57c907b Mon Sep 17 00:00:00 2001 From: David Hassell Date: Tue, 11 Mar 2025 12:55:28 +0000 Subject: [PATCH 1/3] add missing docs --- cf/domain.py | 106 --------- docs/source/class.rst | 20 +- docs/source/class/cf.AuxiliaryCoordinate.rst | 20 +- docs/source/class/cf.Bounds.rst | 21 +- docs/source/class/cf.BoundsFromNodesArray.rst | 58 +++++ docs/source/class/cf.CellConnectivity.rst | 209 ++++++++++++++++++ .../source/class/cf.CellConnectivityArray.rst | 57 +++++ docs/source/class/cf.CellMeasure.rst | 21 +- docs/source/class/cf.Count.rst | 20 +- docs/source/class/cf.Data.rst | 51 +++-- docs/source/class/cf.DimensionCoordinate.rst | 21 +- docs/source/class/cf.Domain.rst | 20 +- docs/source/class/cf.DomainAncillary.rst | 23 +- docs/source/class/cf.DomainTopology.rst | 209 ++++++++++++++++++ docs/source/class/cf.Field.rst | 24 +- docs/source/class/cf.FieldAncillary.rst | 20 +- docs/source/class/cf.FullArray.rst | 113 ++++++++++ docs/source/class/cf.H5netcdfArray.rst | 6 +- docs/source/class/cf.Index.rst | 21 +- docs/source/class/cf.List.rst | 21 +- docs/source/class/cf.NetCDF4Array.rst | 7 +- docs/source/class/cf.PointTopologyArray.rst | 57 +++++ docs/source/class/cf.SubsampledArray.rst | 67 ++++++ docs/source/class/cf.UMArray.rst | 144 ++++++++++++ 24 files changed, 1098 insertions(+), 238 deletions(-) create mode 100644 docs/source/class/cf.BoundsFromNodesArray.rst create mode 100644 docs/source/class/cf.CellConnectivity.rst create mode 100644 docs/source/class/cf.CellConnectivityArray.rst create mode 100644 docs/source/class/cf.DomainTopology.rst create mode 100644 docs/source/class/cf.FullArray.rst create mode 100644 docs/source/class/cf.PointTopologyArray.rst create mode 100644 docs/source/class/cf.SubsampledArray.rst create mode 100644 docs/source/class/cf.UMArray.rst diff --git a/cf/domain.py b/cf/domain.py index 5efa6fc541..6ab754f18b 100644 --- a/cf/domain.py +++ b/cf/domain.py @@ -125,43 +125,6 @@ def size(self): [domain_axis.get_size(0) for domain_axis in domain_axes.values()] ) - def add_file_location( - self, - location, - ): - """Add a new file location in-place. - - All data definitions that reference files are additionally - referenced from the given location. - - .. versionadded:: 3.15.0 - - .. seealso:: `del_file_location`, `file_locations` - - :Parameters: - - location: `str` - The new location. - - :Returns: - - `str` - The new location as an absolute path with no trailing - path name component separator. - - **Examples** - - >>> f.add_file_location('/data/model/') - '/data/model' - - """ - location = abspath(location).rstrip(sep) - - for c in self.constructs.filter_by_data(todict=True).values(): - c.add_file_location(location) - - return location - def close(self): """Close all files referenced by the domain construct. @@ -188,43 +151,6 @@ def close(self): removed_at="5.0.0", ) # pragma: no cover - def del_file_location( - self, - location, - ): - """Remove a file location in-place. - - All data definitions that reference files will have references - to files in the given location removed from them. - - .. versionadded:: 3.15.0 - - .. seealso:: `add_file_location`, `file_locations` - - :Parameters: - - location: `str` - The file location to remove. - - :Returns: - - `str` - The removed location as an absolute path with no - trailing path name component separator. - - **Examples** - - >>> d.del_file_location('/data/model/') - '/data/model' - - """ - location = abspath(location).rstrip(sep) - - for c in self.constructs.filter_by_data(todict=True).values(): - c.del_file_location(location) - - return location - @classmethod def create_regular(cls, x_args, y_args, bounds=True): """ @@ -333,38 +259,6 @@ def create_regular(cls, x_args, y_args, bounds=True): return domain - def file_locations( - self, - ): - """The locations of files containing parts of the components data. - - Returns the locations of any files that may be required to - deliver the computed data arrays of any of the component - constructs (such as dimension coordinate constructs, cell - measure constructs, etc.). - - .. versionadded:: 3.15.0 - - .. seealso:: `add_file_location`, `del_file_location` - - :Returns: - - `set` - The unique file locations as absolute paths with no - trailing path name component separator. - - **Examples** - - >>> d.file_locations() - {'/home/data1', 'file:///data2'} - - """ - out = set() - for c in self.constructs.filter_by_data(todict=True).values(): - out.update(c.file_locations()) - - return out - @_inplace_enabled(default=False) def flip(self, axes=None, inplace=False): """Flip (reverse the direction of) domain axes. diff --git a/docs/source/class.rst b/docs/source/class.rst index cd236ff624..70b9730095 100644 --- a/docs/source/class.rst +++ b/docs/source/class.rst @@ -24,6 +24,15 @@ Field list class cf.FieldList +Domain class +------------ + +.. autosummary:: + :nosignatures: + :toctree: class/ + + cf.Domain + Metadata component classes -------------------------- @@ -32,12 +41,14 @@ Metadata component classes :toctree: class/ cf.AuxiliaryCoordinate + cf.CellConnectivity cf.CellMeasure cf.CellMethod cf.CoordinateReference cf.DimensionCoordinate cf.DomainAncillary cf.DomainAxis + cf.DomainTopology cf.FieldAncillary Constructs class @@ -60,15 +71,6 @@ Coordinate component classes cf.CoordinateConversion cf.Datum -Domain class ------------- - -.. autosummary:: - :nosignatures: - :toctree: class/ - - cf.Domain - Data classes ------------ diff --git a/docs/source/class/cf.AuxiliaryCoordinate.rst b/docs/source/class/cf.AuxiliaryCoordinate.rst index e3d69564ed..610577464c 100644 --- a/docs/source/class/cf.AuxiliaryCoordinate.rst +++ b/docs/source/class/cf.AuxiliaryCoordinate.rst @@ -520,8 +520,8 @@ Groups ~cf.AuxiliaryCoordinate.nc_set_variable_groups ~cf.AuxiliaryCoordinate.nc_clear_variable_groups -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -530,13 +530,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.AuxiliaryCoordinate.add_file_location - ~cf.AuxiliaryCoordinate.cfa_clear_file_substitutions - ~cf.AuxiliaryCoordinate.cfa_del_file_substitution - ~cf.AuxiliaryCoordinate.cfa_file_substitutions - ~cf.AuxiliaryCoordinate.cfa_update_file_substitutions - ~cf.AuxiliaryCoordinate.del_file_location - ~cf.AuxiliaryCoordinate.file_locations + ~cf.AuxiliaryCoordinate.file_directories + ~cf.AuxiliaryCoordinate.replace_directory Aliases ------- @@ -721,11 +716,18 @@ Deprecated :toctree: ../method/ :template: method.rst + ~cf.AuxiliaryCoordinate.add_file_location ~cf.AuxiliaryCoordinate.asdatetime ~cf.AuxiliaryCoordinate.asreftime + ~cf.AuxiliaryCoordinate.cfa_clear_file_substitutions + ~cf.AuxiliaryCoordinate.cfa_del_file_substitution + ~cf.AuxiliaryCoordinate.cfa_file_substitutions + ~cf.AuxiliaryCoordinate.cfa_update_file_substitutions ~cf.AuxiliaryCoordinate.chunk + ~cf.AuxiliaryCoordinate.del_file_location ~cf.AuxiliaryCoordinate.delprop ~cf.AuxiliaryCoordinate.expand_dims + ~cf.AuxiliaryCoordinate.file_locations ~cf.AuxiliaryCoordinate.files ~cf.AuxiliaryCoordinate.get_filenames ~cf.AuxiliaryCoordinate.getprop diff --git a/docs/source/class/cf.Bounds.rst b/docs/source/class/cf.Bounds.rst index 4b31a8836e..d1cff5ad57 100644 --- a/docs/source/class/cf.Bounds.rst +++ b/docs/source/class/cf.Bounds.rst @@ -418,8 +418,8 @@ NetCDF ~cf.Bounds.nc_hdf5_chunksizes ~cf.Bounds.nc_set_hdf5_chunksizes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -428,13 +428,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.Bounds.add_file_location - ~cf.Bounds.cfa_clear_file_substitutions - ~cf.Bounds.cfa_del_file_substitution - ~cf.Bounds.cfa_file_substitutions - ~cf.Bounds.cfa_update_file_substitutions - ~cf.Bounds.del_file_location - ~cf.Bounds.file_locations + ~cf.Bounds.file_directories + ~cf.Bounds.replace_directory Aliases ------- @@ -632,13 +627,21 @@ Deprecated :toctree: ../method/ :template: method.rst + + ~cf.Bounds.add_file_location ~cf.Bounds.asdatetime ~cf.Bounds.asreftime ~cf.Bounds.attributes + ~cf.Bounds.cfa_clear_file_substitutions + ~cf.Bounds.cfa_del_file_substitution + ~cf.Bounds.cfa_file_substitutions + ~cf.Bounds.cfa_update_file_substitutions ~cf.Bounds.chunk + ~cf.Bounds.del_file_location ~cf.Bounds.delprop ~cf.Bounds.dtvarray ~cf.Bounds.expand_dims + ~cf.Bounds.file_locations ~cf.Bounds.getprop ~cf.Bounds.get_filenames ~cf.Bounds.hasbounds diff --git a/docs/source/class/cf.BoundsFromNodesArray.rst b/docs/source/class/cf.BoundsFromNodesArray.rst new file mode 100644 index 0000000000..64f491725d --- /dev/null +++ b/docs/source/class/cf.BoundsFromNodesArray.rst @@ -0,0 +1,58 @@ +.. currentmodule:: cf +.. default-role:: obj + +cf.BoundsFromNodesArray +======================= + +---- + +.. autoclass:: cf.BoundsFromNodesArray + :no-members: + :no-inherited-members: + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.BoundsFromNodesArray.__init__ + ~cf.BoundsFromNodesArray.compressed_dimensions + ~cf.BoundsFromNodesArray.conformed_data + ~cf.BoundsFromNodesArray.copy + ~cf.BoundsFromNodesArray.get_attributes + ~cf.BoundsFromNodesArray.get_Subarray + ~cf.BoundsFromNodesArray.get_calendar + ~cf.BoundsFromNodesArray.get_cell_dimension + ~cf.BoundsFromNodesArray.get_compressed_axes + ~cf.BoundsFromNodesArray.get_compressed_dimension + ~cf.BoundsFromNodesArray.get_compression_type + ~cf.BoundsFromNodesArray.get_filenames + ~cf.BoundsFromNodesArray.get_node_coordinates + ~cf.BoundsFromNodesArray.get_start_index + ~cf.BoundsFromNodesArray.get_subspace + ~cf.BoundsFromNodesArray.get_units + ~cf.BoundsFromNodesArray.source + ~cf.BoundsFromNodesArray.subarray_parameters + ~cf.BoundsFromNodesArray.subarray_shapes + ~cf.BoundsFromNodesArray.subarrays + ~cf.BoundsFromNodesArray.to_dask_array + ~cf.BoundsFromNodesArray.to_memory + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: at + + ~cf.BoundsFromNodesArray.Units + ~cf.BoundsFromNodesArray.array + ~cf.BoundsFromNodesArray.compressed_array + ~cf.BoundsFromNodesArray.dtype + ~cf.BoundsFromNodesArray.ndim + ~cf.BoundsFromNodesArray.shape + ~cf.BoundsFromNodesArray.size + + diff --git a/docs/source/class/cf.CellConnectivity.rst b/docs/source/class/cf.CellConnectivity.rst new file mode 100644 index 0000000000..d2c7605596 --- /dev/null +++ b/docs/source/class/cf.CellConnectivity.rst @@ -0,0 +1,209 @@ +cf.CellConnectivity +=================== + +.. currentmodule:: cf + +.. autoclass:: CellConnectivity + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~CellConnectivity.__init__ + ~CellConnectivity.all + ~CellConnectivity.allclose + ~CellConnectivity.any + ~CellConnectivity.apply_masking + ~CellConnectivity.arccos + ~CellConnectivity.arccosh + ~CellConnectivity.arcsin + ~CellConnectivity.arcsinh + ~CellConnectivity.arctan + ~CellConnectivity.arctanh + ~CellConnectivity.asdatetime + ~CellConnectivity.asreftime + ~CellConnectivity.ceil + ~CellConnectivity.chunk + ~CellConnectivity.clear_properties + ~CellConnectivity.clip + ~CellConnectivity.close + ~CellConnectivity.concatenate + ~CellConnectivity.convert_reference_time + ~CellConnectivity.copy + ~CellConnectivity.cos + ~CellConnectivity.cosh + ~CellConnectivity.count + ~CellConnectivity.count_masked + ~CellConnectivity.creation_commands + ~CellConnectivity.cyclic + ~CellConnectivity.datum + ~CellConnectivity.del_connectivity + ~CellConnectivity.del_data + ~CellConnectivity.del_properties + ~CellConnectivity.del_property + ~CellConnectivity.delprop + ~CellConnectivity.dump + ~CellConnectivity.equals + ~CellConnectivity.equivalent + ~CellConnectivity.exp + ~CellConnectivity.expand_dims + ~CellConnectivity.file_directories + ~CellConnectivity.fill_value + ~CellConnectivity.filled + ~CellConnectivity.flatten + ~CellConnectivity.flip + ~CellConnectivity.floor + ~CellConnectivity.get_connectivity + ~CellConnectivity.get_data + ~CellConnectivity.get_filenames + ~CellConnectivity.get_original_filenames + ~CellConnectivity.get_property + ~CellConnectivity.getprop + ~CellConnectivity.halo + ~CellConnectivity.has_bounds + ~CellConnectivity.has_connectivity + ~CellConnectivity.has_data + ~CellConnectivity.has_property + ~CellConnectivity.hasprop + ~CellConnectivity.identities + ~CellConnectivity.identity + ~CellConnectivity.insert_data + ~CellConnectivity.insert_dimension + ~CellConnectivity.inspect + ~CellConnectivity.iscyclic + ~CellConnectivity.log + ~CellConnectivity.mask_invalid + ~CellConnectivity.masked_invalid + ~CellConnectivity.match + ~CellConnectivity.match_by_identity + ~CellConnectivity.match_by_naxes + ~CellConnectivity.match_by_ncvar + ~CellConnectivity.match_by_property + ~CellConnectivity.match_by_units + ~CellConnectivity.max + ~CellConnectivity.maximum + ~CellConnectivity.mean + ~CellConnectivity.mid_range + ~CellConnectivity.min + ~CellConnectivity.minimum + ~CellConnectivity.name + ~CellConnectivity.nc_clear_hdf5_chunksizes + ~CellConnectivity.nc_clear_variable_groups + ~CellConnectivity.nc_del_variable + ~CellConnectivity.nc_get_variable + ~CellConnectivity.nc_has_variable + ~CellConnectivity.nc_hdf5_chunksizes + ~CellConnectivity.nc_set_hdf5_chunksizes + ~CellConnectivity.nc_set_variable + ~CellConnectivity.nc_set_variable_groups + ~CellConnectivity.nc_variable_groups + ~CellConnectivity.normalise + ~CellConnectivity.override_calendar + ~CellConnectivity.override_units + ~CellConnectivity.pad_missing + ~CellConnectivity.period + ~CellConnectivity.persist + ~CellConnectivity.properties + ~CellConnectivity.range + ~CellConnectivity.rechunk + ~CellConnectivity.remove_data + ~CellConnectivity.replace_directory + ~CellConnectivity.rint + ~CellConnectivity.roll + ~CellConnectivity.round + ~CellConnectivity.sample_size + ~CellConnectivity.sd + ~CellConnectivity.select + ~CellConnectivity.set_connectivity + ~CellConnectivity.set_data + ~CellConnectivity.set_properties + ~CellConnectivity.set_property + ~CellConnectivity.setprop + ~CellConnectivity.sin + ~CellConnectivity.sinh + ~CellConnectivity.squeeze + ~CellConnectivity.standard_deviation + ~CellConnectivity.sum + ~CellConnectivity.swapaxes + ~CellConnectivity.tan + ~CellConnectivity.tanh + ~CellConnectivity.to_dask_array + ~CellConnectivity.to_memory + ~CellConnectivity.transpose + ~CellConnectivity.trunc + ~CellConnectivity.uncompress + ~CellConnectivity.unique + ~CellConnectivity.var + ~CellConnectivity.variance + ~CellConnectivity.where + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~CellConnectivity.Data + ~CellConnectivity.T + ~CellConnectivity.Units + ~CellConnectivity.X + ~CellConnectivity.Y + ~CellConnectivity.Z + ~CellConnectivity.add_offset + ~CellConnectivity.array + ~CellConnectivity.attributes + ~CellConnectivity.binary_mask + ~CellConnectivity.calendar + ~CellConnectivity.comment + ~CellConnectivity.connectivity + ~CellConnectivity.construct_type + ~CellConnectivity.data + ~CellConnectivity.datetime_array + ~CellConnectivity.day + ~CellConnectivity.dtarray + ~CellConnectivity.dtvarray + ~CellConnectivity.dtype + ~CellConnectivity.hardmask + ~CellConnectivity.hasbounds + ~CellConnectivity.hasdata + ~CellConnectivity.history + ~CellConnectivity.hour + ~CellConnectivity.id + ~CellConnectivity.isauxiliary + ~CellConnectivity.isdimension + ~CellConnectivity.isdomainancillary + ~CellConnectivity.isfieldancillary + ~CellConnectivity.ismeasure + ~CellConnectivity.isperiodic + ~CellConnectivity.isscalar + ~CellConnectivity.leap_month + ~CellConnectivity.leap_year + ~CellConnectivity.long_name + ~CellConnectivity.mask + ~CellConnectivity.minute + ~CellConnectivity.missing_value + ~CellConnectivity.month + ~CellConnectivity.month_lengths + ~CellConnectivity.ndim + ~CellConnectivity.reference_datetime + ~CellConnectivity.scale_factor + ~CellConnectivity.second + ~CellConnectivity.shape + ~CellConnectivity.size + ~CellConnectivity.standard_name + ~CellConnectivity.subspace + ~CellConnectivity.units + ~CellConnectivity.unsafe_array + ~CellConnectivity.valid_max + ~CellConnectivity.valid_min + ~CellConnectivity.valid_range + ~CellConnectivity.varray + ~CellConnectivity.year + + \ No newline at end of file diff --git a/docs/source/class/cf.CellConnectivityArray.rst b/docs/source/class/cf.CellConnectivityArray.rst new file mode 100644 index 0000000000..a9ea7eb865 --- /dev/null +++ b/docs/source/class/cf.CellConnectivityArray.rst @@ -0,0 +1,57 @@ +.. currentmodule:: cf +.. default-role:: obj + +cf.CellConnectivityArray +======================= + +---- + +.. autoclass:: cf.CellConnectivityArray + :no-members: + :no-inherited-members: + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivityArray.__init__ + ~cf.CellConnectivityArray.compressed_dimensions + ~cf.CellConnectivityArray.conformed_data + ~cf.CellConnectivityArray.copy + ~cf.CellConnectivityArray.get_attributes + ~cf.CellConnectivityArray.get_Subarray + ~cf.CellConnectivityArray.get_calendar + ~cf.CellConnectivityArray.get_cell_dimension + ~cf.CellConnectivityArray.get_compressed_axes + ~cf.CellConnectivityArray.get_compressed_dimension + ~cf.CellConnectivityArray.get_compression_type + ~cf.CellConnectivityArray.get_filenames + ~cf.CellConnectivityArray.get_start_index + ~cf.CellConnectivityArray.get_subspace + ~cf.CellConnectivityArray.get_units + ~cf.CellConnectivityArray.source + ~cf.CellConnectivityArray.subarray_parameters + ~cf.CellConnectivityArray.subarray_shapes + ~cf.CellConnectivityArray.subarrays + ~cf.CellConnectivityArray.to_dask_array + ~cf.CellConnectivityArray.to_memory + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivityArray.Units + ~cf.CellConnectivityArray.array + ~cf.CellConnectivityArray.compressed_array + ~cf.CellConnectivityArray.dtype + ~cf.CellConnectivityArray.ndim + ~cf.CellConnectivityArray.shape + ~cf.CellConnectivityArray.size + + diff --git a/docs/source/class/cf.CellMeasure.rst b/docs/source/class/cf.CellMeasure.rst index 96a7727675..02b4871231 100644 --- a/docs/source/class/cf.CellMeasure.rst +++ b/docs/source/class/cf.CellMeasure.rst @@ -438,8 +438,8 @@ NetCDF ~cf.CellMeasure.nc_hdf5_chunksizes ~cf.CellMeasure.nc_set_hdf5_chunksizes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -448,13 +448,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.CellMeasure.add_file_location - ~cf.CellMeasure.cfa_clear_file_substitutions - ~cf.CellMeasure.cfa_del_file_substitution - ~cf.CellMeasure.cfa_file_substitutions - ~cf.CellMeasure.cfa_update_file_substitutions - ~cf.CellMeasure.del_file_location - ~cf.CellMeasure.file_locations + ~cf.CellMeasure.file_directories + ~cf.CellMeasure.replace_directory Aliases ------- @@ -649,13 +644,21 @@ Deprecated :toctree: ../method/ :template: method.rst + + ~cf.CellMeasure.add_file_location ~cf.CellMeasure.asdatetime ~cf.CellMeasure.asreftime ~cf.CellMeasure.attributes + ~cf.CellMeasure.cfa_clear_file_substitutions + ~cf.CellMeasure.cfa_del_file_substitution + ~cf.CellMeasure.cfa_file_substitutions + ~cf.CellMeasure.cfa_update_file_substitutions ~cf.CellMeasure.chunk + ~cf.CellMeasure.del_file_location ~cf.CellMeasure.delprop ~cf.CellMeasure.dtvarray ~cf.CellMeasure.expand_dims + ~cf.CellMeasure.file_locations ~cf.CellMeasure.get_filenames ~cf.CellMeasure.getprop ~cf.CellMeasure.hasbounds diff --git a/docs/source/class/cf.Count.rst b/docs/source/class/cf.Count.rst index 64f71624fc..43017e9d5b 100644 --- a/docs/source/class/cf.Count.rst +++ b/docs/source/class/cf.Count.rst @@ -415,8 +415,8 @@ NetCDF ~cf.Count.nc_hdf5_chunksizes ~cf.Count.nc_set_hdf5_chunksizes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -425,13 +425,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.Count.add_file_location - ~cf.Count.cfa_clear_file_substitutions - ~cf.Count.cfa_del_file_substitution - ~cf.Count.cfa_file_substitutions - ~cf.Count.cfa_update_file_substitutions - ~cf.Count.del_file_location - ~cf.Count.file_locations + ~cf.Count.file_directories + ~cf.Count.replace_directory Aliases ------- @@ -632,14 +627,21 @@ Deprecated :toctree: ../method/ :template: method.rst + ~cf.Count.add_file_location ~cf.Count.asdatetime ~cf.Count.asreftime ~cf.Count.attributes + ~cf.Count.cfa_clear_file_substitutions + ~cf.Count.cfa_del_file_substitution + ~cf.Count.cfa_file_substitutions + ~cf.Count.cfa_update_file_substitutions ~cf.Count.chunk ~cf.Count.Data + ~cf.Count.del_file_location ~cf.Count.delprop ~cf.Count.dtvarray ~cf.Count.expand_dims + ~cf.Count.file_locations ~cf.Count.get_filenames ~cf.Count.getprop ~cf.Count.halo diff --git a/docs/source/class/cf.Data.rst b/docs/source/class/cf.Data.rst index 625daccbe2..df1e94cf98 100644 --- a/docs/source/class/cf.Data.rst +++ b/docs/source/class/cf.Data.rst @@ -87,6 +87,7 @@ Dask ~cf.Data.chunks ~cf.Data.chunksize + ~cf.Data.chunk_positions ~cf.Data.npartitions ~cf.Data.numblocks @@ -669,31 +670,25 @@ Performance ~cf.Data.npartitions ~cf.Data.numblocks - -CFA ---- +Aggregation +----------- .. autosummary:: :nosignatures: :toctree: ../method/ :template: method.rst - - ~cf.Data.file_locations - ~cf.Data.del_file_location - ~cf.Data.add_file_location - ~cf.Data.cfa_clear_file_substitutions - ~cf.Data.cfa_file_substitutions - ~cf.Data.cfa_update_file_substitutions - ~cf.Data.cfa_del_file_substitution - ~cf.Data.cfa_has_file_substitutions - ~cf.Data.cfa_del_aggregated_data - ~cf.Data.cfa_get_aggregated_data - ~cf.Data.cfa_has_aggregated_data - ~cf.Data.cfa_set_aggregated_data - ~cf.Data.cfa_get_term - ~cf.Data.cfa_get_write - ~cf.Data.cfa_set_term - ~cf.Data.cfa_set_write + + ~cf.Data.file_directories + ~cf.Data.replace_directory + ~cf.Data.replace_filenames + ~cf.Data.nc_del_aggregated_data + ~cf.Data.nc_del_aggregation_write_status + ~cf.Data.nc_get_aggregated_data + ~cf.Data.nc_get_aggregation_fragment_type + ~cf.Data.nc_get_aggregation_write_status + ~cf.Data.nc_has_aggregated_data + ~cf.Data.nc_set_aggregated_data + ~cf.Data.nc_set_aggregation_write_status Element-wise arithmetic, bit and comparison operations ------------------------------------------------------ @@ -863,13 +858,29 @@ Deprecated :toctree: ../method/ :template: method.rst + ~cf.Data.add_file_location + ~cf.Data.cfa_clear_file_substitutions + ~cf.Data.cfa_file_substitutions + ~cf.Data.cfa_update_file_substitutions + ~cf.Data.cfa_del_file_substitution + ~cf.Data.cfa_has_file_substitutions + ~cf.Data.cfa_del_aggregated_data + ~cf.Data.cfa_get_aggregated_data + ~cf.Data.cfa_has_aggregated_data + ~cf.Data.cfa_set_aggregated_data + ~cf.Data.cfa_get_term + ~cf.Data.cfa_get_write + ~cf.Data.cfa_set_term + ~cf.Data.cfa_set_write ~cf.Data.chunk ~cf.Data.Data + ~cf.Data.del_file_location ~cf.Data.dtvarray ~cf.Data.dumpd ~cf.Data.dumps ~cf.Data.expand_dims ~cf.Data.files + ~cf.Data.file_locations ~cf.Data.fits_in_one_chunk_in_memory ~cf.Data.HDF_chunks ~cf.Data.in_memory diff --git a/docs/source/class/cf.DimensionCoordinate.rst b/docs/source/class/cf.DimensionCoordinate.rst index b031250aa6..7c46395bc0 100644 --- a/docs/source/class/cf.DimensionCoordinate.rst +++ b/docs/source/class/cf.DimensionCoordinate.rst @@ -346,6 +346,7 @@ Cyclicity ~cf.DimensionCoordinate.cyclic ~cf.DimensionCoordinate.get_original_filenames ~cf.DimensionCoordinate.period + ~cf.DimensionCoordinate.anchor ~cf.DimensionCoordinate.persist Miscellaneous @@ -525,8 +526,8 @@ Groups ~cf.DimensionCoordinate.nc_set_variable_groups ~cf.DimensionCoordinate.nc_clear_variable_groups -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -535,13 +536,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.DimensionCoordinate.add_file_location - ~cf.DimensionCoordinate.cfa_clear_file_substitutions - ~cf.DimensionCoordinate.cfa_del_file_substitution - ~cf.DimensionCoordinate.cfa_file_substitutions - ~cf.DimensionCoordinate.cfa_update_file_substitutions - ~cf.DimensionCoordinate.del_file_location - ~cf.DimensionCoordinate.file_locations + ~cf.DimensionCoordinate.file_directories + ~cf.DimensionCoordinate.replace_directory Aliases ------- @@ -726,11 +722,18 @@ Deprecated :toctree: ../method/ :template: method.rst + ~cf.DimensionCoordinate.add_file_location ~cf.DimensionCoordinate.asdatetime ~cf.DimensionCoordinate.asreftime + ~cf.DimensionCoordinate.cfa_clear_file_substitutions + ~cf.DimensionCoordinate.cfa_del_file_substitution + ~cf.DimensionCoordinate.cfa_file_substitutions + ~cf.DimensionCoordinate.cfa_update_file_substitutions ~cf.DimensionCoordinate.chunk + ~cf.DimensionCoordinate.del_file_location ~cf.DimensionCoordinate.delprop ~cf.DimensionCoordinate.expand_dims + ~cf.DimensionCoordinate.file_locations ~cf.DimensionCoordinate.files ~cf.DimensionCoordinate.get_filenames ~cf.DimensionCoordinate.getprop diff --git a/docs/source/class/cf.Domain.rst b/docs/source/class/cf.Domain.rst index e3d076733f..7f75c0b3ac 100644 --- a/docs/source/class/cf.Domain.rst +++ b/docs/source/class/cf.Domain.rst @@ -190,6 +190,7 @@ Miscellaneous ~cf.Domain.apply_masking ~cf.Domain.get_original_filenames ~cf.Domain.close + ~cf.Domain.persist ~cf.Domain.uncompress Domain axes @@ -257,8 +258,8 @@ Groups ~cf.Domain.nc_set_group_attribute ~cf.Domain.nc_set_group_attributes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -267,13 +268,7 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.Domain.add_file_location - ~cf.Domain.cfa_clear_file_substitutions - ~cf.Domain.cfa_del_file_substitution - ~cf.Domain.cfa_file_substitutions - ~cf.Domain.cfa_update_file_substitutions - ~cf.Domain.del_file_location - ~cf.Domain.file_locations + ~cf.Domain.file_locations Geometries ^^^^^^^^^^ @@ -365,6 +360,13 @@ Deprecated :toctree: ../method/ :template: method.rst + + ~cf.Domain.add_file_location + ~cf.Domain.cfa_clear_file_substitutions + ~cf.Domain.cfa_del_file_substitution + ~cf.Domain.cfa_file_substitutions + ~cf.Domain.cfa_update_file_substitutions + ~cf.Domain.del_file_location ~cf.Domain.delprop ~cf.Domain.get_filenames ~cf.Domain.getprop diff --git a/docs/source/class/cf.DomainAncillary.rst b/docs/source/class/cf.DomainAncillary.rst index f9b5e2fa3d..118b2fe4e1 100644 --- a/docs/source/class/cf.DomainAncillary.rst +++ b/docs/source/class/cf.DomainAncillary.rst @@ -467,8 +467,8 @@ NetCDF ~cf.DomainAncillary.nc_hdf5_chunksizes ~cf.DomainAncillary.nc_set_hdf5_chunksizes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -477,13 +477,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.DomainAncillary.add_file_location - ~cf.DomainAncillary.cfa_clear_file_substitutions - ~cf.DomainAncillary.cfa_del_file_substitution - ~cf.DomainAncillary.cfa_file_substitutions - ~cf.DomainAncillary.cfa_update_file_substitutions - ~cf.DomainAncillary.del_file_location - ~cf.DomainAncillary.file_locations + ~cf.DomainAncillary.file_directories + ~cf.DomainAncillary.replace_directory Aliases ------- @@ -678,13 +673,22 @@ Deprecated :toctree: ../method/ :template: method.rst + + ~cf.DomainAncillary.add_file_location ~cf.DomainAncillary.asdatetime ~cf.DomainAncillary.asreftime ~cf.DomainAncillary.attributes ~cf.DomainAncillary.chunk + ~cf.DomainAncillary.cfa_clear_file_substitutions + ~cf.DomainAncillary.cfa_del_file_substitution + ~cf.DomainAncillary.cfa_file_substitutions + ~cf.DomainAncillary.cfa_update_file_substitutions + ~cf.DomainAncillary.del_file_location ~cf.DomainAncillary.delprop ~cf.DomainAncillary.dtvarray ~cf.DomainAncillary.expand_dims + ~cf.DomainAncillary.files + ~cf.DomainAncillary.file_locations ~cf.DomainAncillary.get_filenames ~cf.DomainAncillary.getprop ~cf.DomainAncillary.hasbounds @@ -702,4 +706,3 @@ Deprecated ~cf.DomainAncillary.select ~cf.DomainAncillary.setprop ~cf.DomainAncillary.unsafe_array - ~cf.DomainAncillary.files diff --git a/docs/source/class/cf.DomainTopology.rst b/docs/source/class/cf.DomainTopology.rst new file mode 100644 index 0000000000..2b2402f7d6 --- /dev/null +++ b/docs/source/class/cf.DomainTopology.rst @@ -0,0 +1,209 @@ +cf.DomainTopology +================= + +.. currentmodule:: cf + +.. autoclass:: DomainTopology + + + .. automethod:: __init__ + + + .. rubric:: Methods + + .. autosummary:: + + ~DomainTopology.__init__ + ~DomainTopology.all + ~DomainTopology.allclose + ~DomainTopology.any + ~DomainTopology.apply_masking + ~DomainTopology.arccos + ~DomainTopology.arccosh + ~DomainTopology.arcsin + ~DomainTopology.arcsinh + ~DomainTopology.arctan + ~DomainTopology.arctanh + ~DomainTopology.asdatetime + ~DomainTopology.asreftime + ~DomainTopology.ceil + ~DomainTopology.chunk + ~DomainTopology.clear_properties + ~DomainTopology.clip + ~DomainTopology.close + ~DomainTopology.concatenate + ~DomainTopology.convert_reference_time + ~DomainTopology.copy + ~DomainTopology.cos + ~DomainTopology.cosh + ~DomainTopology.count + ~DomainTopology.count_masked + ~DomainTopology.creation_commands + ~DomainTopology.cyclic + ~DomainTopology.datum + ~DomainTopology.del_cell + ~DomainTopology.del_data + ~DomainTopology.del_properties + ~DomainTopology.del_property + ~DomainTopology.delprop + ~DomainTopology.dump + ~DomainTopology.equals + ~DomainTopology.equivalent + ~DomainTopology.exp + ~DomainTopology.expand_dims + ~DomainTopology.file_directories + ~DomainTopology.fill_value + ~DomainTopology.filled + ~DomainTopology.flatten + ~DomainTopology.flip + ~DomainTopology.floor + ~DomainTopology.get_cell + ~DomainTopology.get_data + ~DomainTopology.get_filenames + ~DomainTopology.get_original_filenames + ~DomainTopology.get_property + ~DomainTopology.getprop + ~DomainTopology.halo + ~DomainTopology.has_bounds + ~DomainTopology.has_cell + ~DomainTopology.has_data + ~DomainTopology.has_property + ~DomainTopology.hasprop + ~DomainTopology.identities + ~DomainTopology.identity + ~DomainTopology.insert_data + ~DomainTopology.insert_dimension + ~DomainTopology.inspect + ~DomainTopology.iscyclic + ~DomainTopology.log + ~DomainTopology.mask_invalid + ~DomainTopology.masked_invalid + ~DomainTopology.match + ~DomainTopology.match_by_identity + ~DomainTopology.match_by_naxes + ~DomainTopology.match_by_ncvar + ~DomainTopology.match_by_property + ~DomainTopology.match_by_units + ~DomainTopology.max + ~DomainTopology.maximum + ~DomainTopology.mean + ~DomainTopology.mid_range + ~DomainTopology.min + ~DomainTopology.minimum + ~DomainTopology.name + ~DomainTopology.nc_clear_hdf5_chunksizes + ~DomainTopology.nc_clear_variable_groups + ~DomainTopology.nc_del_variable + ~DomainTopology.nc_get_variable + ~DomainTopology.nc_has_variable + ~DomainTopology.nc_hdf5_chunksizes + ~DomainTopology.nc_set_hdf5_chunksizes + ~DomainTopology.nc_set_variable + ~DomainTopology.nc_set_variable_groups + ~DomainTopology.nc_variable_groups + ~DomainTopology.normalise + ~DomainTopology.override_calendar + ~DomainTopology.override_units + ~DomainTopology.pad_missing + ~DomainTopology.period + ~DomainTopology.persist + ~DomainTopology.properties + ~DomainTopology.range + ~DomainTopology.rechunk + ~DomainTopology.remove_data + ~DomainTopology.replace_directory + ~DomainTopology.rint + ~DomainTopology.roll + ~DomainTopology.round + ~DomainTopology.sample_size + ~DomainTopology.sd + ~DomainTopology.select + ~DomainTopology.set_cell + ~DomainTopology.set_data + ~DomainTopology.set_properties + ~DomainTopology.set_property + ~DomainTopology.setprop + ~DomainTopology.sin + ~DomainTopology.sinh + ~DomainTopology.squeeze + ~DomainTopology.standard_deviation + ~DomainTopology.sum + ~DomainTopology.swapaxes + ~DomainTopology.tan + ~DomainTopology.tanh + ~DomainTopology.to_dask_array + ~DomainTopology.to_memory + ~DomainTopology.transpose + ~DomainTopology.trunc + ~DomainTopology.uncompress + ~DomainTopology.unique + ~DomainTopology.var + ~DomainTopology.variance + ~DomainTopology.where + + + + + + .. rubric:: Attributes + + .. autosummary:: + + ~DomainTopology.Data + ~DomainTopology.T + ~DomainTopology.Units + ~DomainTopology.X + ~DomainTopology.Y + ~DomainTopology.Z + ~DomainTopology.add_offset + ~DomainTopology.array + ~DomainTopology.attributes + ~DomainTopology.binary_mask + ~DomainTopology.calendar + ~DomainTopology.cell + ~DomainTopology.comment + ~DomainTopology.construct_type + ~DomainTopology.data + ~DomainTopology.datetime_array + ~DomainTopology.day + ~DomainTopology.dtarray + ~DomainTopology.dtvarray + ~DomainTopology.dtype + ~DomainTopology.hardmask + ~DomainTopology.hasbounds + ~DomainTopology.hasdata + ~DomainTopology.history + ~DomainTopology.hour + ~DomainTopology.id + ~DomainTopology.isauxiliary + ~DomainTopology.isdimension + ~DomainTopology.isdomainancillary + ~DomainTopology.isfieldancillary + ~DomainTopology.ismeasure + ~DomainTopology.isperiodic + ~DomainTopology.isscalar + ~DomainTopology.leap_month + ~DomainTopology.leap_year + ~DomainTopology.long_name + ~DomainTopology.mask + ~DomainTopology.minute + ~DomainTopology.missing_value + ~DomainTopology.month + ~DomainTopology.month_lengths + ~DomainTopology.ndim + ~DomainTopology.reference_datetime + ~DomainTopology.scale_factor + ~DomainTopology.second + ~DomainTopology.shape + ~DomainTopology.size + ~DomainTopology.standard_name + ~DomainTopology.subspace + ~DomainTopology.units + ~DomainTopology.unsafe_array + ~DomainTopology.valid_max + ~DomainTopology.valid_min + ~DomainTopology.valid_range + ~DomainTopology.varray + ~DomainTopology.year + + \ No newline at end of file diff --git a/docs/source/class/cf.Field.rst b/docs/source/class/cf.Field.rst index eed7dad7ac..ecf849dabf 100644 --- a/docs/source/class/cf.Field.rst +++ b/docs/source/class/cf.Field.rst @@ -263,6 +263,7 @@ Miscellaneous data operations ~cf.Field.close ~cf.Field.rechunk ~cf.Field.persist + ~cf.Field.persist_metadata Metadata constructs ------------------- @@ -438,8 +439,8 @@ Groups ~cf.Field.nc_set_group_attribute ~cf.Field.nc_set_group_attributes -CFA -^^^ +Aggregation +^^^^^^^^^^^ .. rubric:: Methods @@ -447,14 +448,9 @@ CFA :nosignatures: :toctree: ../method/ :template: method.rst - - ~cf.Field.file_locations - ~cf.Field.add_file_location - ~cf.Field.del_file_location - ~cf.Field.cfa_clear_file_substitutions - ~cf.Field.cfa_del_file_substitution - ~cf.Field.cfa_file_substitutions - ~cf.Field.cfa_update_file_substitutions + + ~cf.Field.file_directories + ~cf.Field.replace_directory Geometries ^^^^^^^^^^ @@ -990,16 +986,24 @@ Deprecated :toctree: ../method/ :template: method.rst + + ~cf.Field.add_file_location ~cf.Field.asdatetime ~cf.Field.asreftime ~cf.Field.axis_name + ~cf.Field.cfa_clear_file_substitutions + ~cf.Field.cfa_del_file_substitution + ~cf.Field.cfa_file_substitutions + ~cf.Field.cfa_update_file_substitutions ~cf.Field.chunk ~cf.Field.data_axes + ~cf.Field.del_file_location ~cf.Field.delprop ~cf.Field.equivalent ~cf.Field.example_field ~cf.Field.expand_dims ~cf.Field.field + ~cf.Field.file_locations ~cf.Field.get_filenames ~cf.Field.getprop ~cf.Field.HDF_chunks diff --git a/docs/source/class/cf.FieldAncillary.rst b/docs/source/class/cf.FieldAncillary.rst index 0afc0fa7a9..089654a4dd 100644 --- a/docs/source/class/cf.FieldAncillary.rst +++ b/docs/source/class/cf.FieldAncillary.rst @@ -412,8 +412,8 @@ NetCDF ~cf.FieldAncillary.nc_hdf5_chunksizes ~cf.FieldAncillary.nc_set_hdf5_chunksizes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -422,13 +422,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.FieldAncillary.add_file_location - ~cf.FieldAncillary.cfa_clear_file_substitutions - ~cf.FieldAncillary.cfa_del_file_substitution - ~cf.FieldAncillary.cfa_file_substitutions - ~cf.FieldAncillary.cfa_update_file_substitutions - ~cf.FieldAncillary.del_file_location - ~cf.FieldAncillary.file_locations + ~cf.FieldAncillary.file_directories + ~cf.FieldAncillary.replace_directory Aliases ------- @@ -623,14 +618,21 @@ Deprecated :toctree: ../method/ :template: method.rst + ~cf.FieldAncillary.add_file_location ~cf.FieldAncillary.asdatetime ~cf.FieldAncillary.asreftime ~cf.FieldAncillary.attributes + ~cf.FieldAncillary.cfa_clear_file_substitutions + ~cf.FieldAncillary.cfa_del_file_substitution + ~cf.FieldAncillary.cfa_file_substitutions + ~cf.FieldAncillary.cfa_update_file_substitutions ~cf.FieldAncillary.chunk + ~cf.FieldAncillary.del_file_location ~cf.FieldAncillary.delprop ~cf.FieldAncillary.dtvarray ~cf.FieldAncillary.expand_dims ~cf.FieldAncillary.get_filenames + ~cf.FieldAncillary.file_locations ~cf.FieldAncillary.getprop ~cf.FieldAncillary.hasbounds ~cf.FieldAncillary.hasdata diff --git a/docs/source/class/cf.FullArray.rst b/docs/source/class/cf.FullArray.rst new file mode 100644 index 0000000000..637c7e4682 --- /dev/null +++ b/docs/source/class/cf.FullArray.rst @@ -0,0 +1,113 @@ +.. currentmodule:: cf +.. default-role:: obj + +cf.FullArray +============ + +---- + +.. autoclass:: cf.FullArray + :no-members: + :no-inherited-members: + +Inspection +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.FullArray.get_compression_type + ~cf.FullArray.get_subspace + ~cf.FullArray.get_attributes + ~cf.FullArray.index + ~cf.FullArray.is_subspace + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.FullArray.array + ~cf.FullArray.dtype + ~cf.FullArray.ndim + ~cf.FullArray.shape + ~cf.FullArray.size + ~cf.FullArray.original_shape + ~cf.FullArray.reference_shape + +Full value +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.FullArray.get_full_value + ~cf.FullArray.set_full_value + +Units +----- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.FullArray.get_calendar + ~cf.FullArray.get_units + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.FullArray.Units + +Miscellaneous +------------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.FullArray.copy + + +Special +------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.FullArray.__getitem__ + +Docstring substitutions +----------------------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.FullArray._docstring_special_substitutions + ~cf.FullArray._docstring_substitutions + ~cf.FullArray._docstring_package_depth + ~cf.FullArray._docstring_method_exclusions diff --git a/docs/source/class/cf.H5netcdfArray.rst b/docs/source/class/cf.H5netcdfArray.rst index 6b51c6bc5a..d00c5fb17d 100644 --- a/docs/source/class/cf.H5netcdfArray.rst +++ b/docs/source/class/cf.H5netcdfArray.rst @@ -24,7 +24,7 @@ Inspection ~cf.H5netcdfArray.get_subspace ~cf.H5netcdfArray.get_attributes ~cf.H5netcdfArray.index - + ~cf.H5netcdfArray.is_subspace .. rubric:: Attributes @@ -39,6 +39,7 @@ Inspection ~cf.H5netcdfArray.shape ~cf.H5netcdfArray.size ~cf.H5netcdfArray.original_shape + ~cf.H5netcdfArray.reference_shape Units ----- @@ -79,6 +80,9 @@ File ~cf.H5netcdfArray.add_file_location ~cf.H5netcdfArray.del_file_location ~cf.H5netcdfArray.file_locations + ~cf.H5netcdfArray.file_directory + ~cf.H5netcdfArray.replace_directory + ~cf.H5netcdfArray.replace_filename ~cf.H5netcdfArray._lock Miscellaneous diff --git a/docs/source/class/cf.Index.rst b/docs/source/class/cf.Index.rst index 46cc545cd6..339fc61099 100644 --- a/docs/source/class/cf.Index.rst +++ b/docs/source/class/cf.Index.rst @@ -416,8 +416,8 @@ NetCDF ~cf.Index.nc_hdf5_chunksizes ~cf.Index.nc_set_hdf5_chunksizes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -426,13 +426,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.Index.add_file_location - ~cf.Index.cfa_clear_file_substitutions - ~cf.Index.cfa_del_file_substitution - ~cf.Index.cfa_file_substitutions - ~cf.Index.cfa_update_file_substitutions - ~cf.Index.del_file_location - ~cf.Index.file_locations + ~cf.Index.file_directories + ~cf.Index.replace_directory Aliases ------- @@ -633,14 +628,22 @@ Deprecated :toctree: ../method/ :template: method.rst + + ~cf.Index.add_file_location ~cf.Index.asdatetime ~cf.Index.asreftime ~cf.Index.attributes + ~cf.Index.cfa_clear_file_substitutions + ~cf.Index.cfa_del_file_substitution + ~cf.Index.cfa_file_substitutions + ~cf.Index.cfa_update_file_substitutions ~cf.Index.chunk ~cf.Index.Data + ~cf.Index.del_file_location ~cf.Index.delprop ~cf.Index.dtvarray ~cf.Index.expand_dims + ~cf.Index.file_locations ~cf.Index.get_filenames ~cf.Index.getprop ~cf.Index.hasbounds diff --git a/docs/source/class/cf.List.rst b/docs/source/class/cf.List.rst index 5e8de3f544..52cd8e4193 100644 --- a/docs/source/class/cf.List.rst +++ b/docs/source/class/cf.List.rst @@ -408,8 +408,8 @@ NetCDF ~cf.List.nc_hdf5_chunksizes ~cf.List.nc_set_hdf5_chunksizes -CFA ---- +Aggregation +----------- .. rubric:: Methods @@ -418,13 +418,8 @@ CFA :toctree: ../method/ :template: method.rst - ~cf.List.add_file_location - ~cf.List.cfa_clear_file_substitutions - ~cf.List.cfa_del_file_substitution - ~cf.List.cfa_file_substitutions - ~cf.List.cfa_update_file_substitutions - ~cf.List.del_file_location - ~cf.List.file_locations + ~cf.List.file_directories + ~cf.List.replace_directory Aliases ------- @@ -619,14 +614,22 @@ Deprecated :toctree: ../method/ :template: method.rst + + ~cf.List.add_file_location ~cf.List.asdatetime ~cf.List.asreftime ~cf.List.attributes + ~cf.List.cfa_clear_file_substitutions + ~cf.List.cfa_del_file_substitution + ~cf.List.cfa_file_substitutions + ~cf.List.cfa_update_file_substitutions ~cf.List.chunk ~cf.List.Data + ~cf.List.del_file_location ~cf.List.delprop ~cf.List.dtvarray ~cf.List.expand_dims + ~cf.List.file_locations ~cf.List.get_filenames ~cf.List.getprop ~cf.List.hasbounds diff --git a/docs/source/class/cf.NetCDF4Array.rst b/docs/source/class/cf.NetCDF4Array.rst index f3e668ec92..a90666f5b5 100644 --- a/docs/source/class/cf.NetCDF4Array.rst +++ b/docs/source/class/cf.NetCDF4Array.rst @@ -24,7 +24,7 @@ Inspection ~cf.NetCDF4Array.get_subspace ~cf.NetCDF4Array.get_attributes ~cf.NetCDF4Array.index - + ~cf.NetCDF4Array.is_subspace .. rubric:: Attributes @@ -39,6 +39,7 @@ Inspection ~cf.NetCDF4Array.shape ~cf.NetCDF4Array.size ~cf.NetCDF4Array.original_shape + ~cf.NetCDF4Array.reference_shape Units ----- @@ -81,7 +82,11 @@ File ~cf.NetCDF4Array.add_file_location ~cf.NetCDF4Array.del_file_location ~cf.NetCDF4Array.file_locations + ~cf.NetCDF4Array.file_directory + ~cf.NetCDF4Array.replace_directory + ~cf.NetCDF4Array.replace_filename ~cf.NetCDF4Array._lock + Miscellaneous ------------- diff --git a/docs/source/class/cf.PointTopologyArray.rst b/docs/source/class/cf.PointTopologyArray.rst new file mode 100644 index 0000000000..cc112c021c --- /dev/null +++ b/docs/source/class/cf.PointTopologyArray.rst @@ -0,0 +1,57 @@ +.. currentmodule:: cf +.. default-role:: obj + +cf.PointTopologyArray +===================== + +---- + +.. autoclass:: cf.PointTopologyArray + :no-members: + :no-inherited-members: + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.PointTopologyArray.__init__ + ~cf.PointTopologyArray.compressed_dimensions + ~cf.PointTopologyArray.conformed_data + ~cf.PointTopologyArray.copy + ~cf.PointTopologyArray.get_attributes + ~cf.PointTopologyArray.get_Subarray + ~cf.PointTopologyArray.get_calendar + ~cf.PointTopologyArray.get_cell_dimension + ~cf.PointTopologyArray.get_compressed_axes + ~cf.PointTopologyArray.get_compressed_dimension + ~cf.PointTopologyArray.get_compression_type + ~cf.PointTopologyArray.get_filenames + ~cf.PointTopologyArray.get_start_index + ~cf.PointTopologyArray.get_subspace + ~cf.PointTopologyArray.get_units + ~cf.PointTopologyArray.source + ~cf.PointTopologyArray.subarray_parameters + ~cf.PointTopologyArray.subarray_shapes + ~cf.PointTopologyArray.subarrays + ~cf.PointTopologyArray.to_dask_array + ~cf.PointTopologyArray.to_memory + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.PointTopologyArray.Units + ~cf.PointTopologyArray.array + ~cf.PointTopologyArray.compressed_array + ~cf.PointTopologyArray.dtype + ~cf.PointTopologyArray.ndim + ~cf.PointTopologyArray.shape + ~cf.PointTopologyArray.size + + diff --git a/docs/source/class/cf.SubsampledArray.rst b/docs/source/class/cf.SubsampledArray.rst new file mode 100644 index 0000000000..3a6f48aeae --- /dev/null +++ b/docs/source/class/cf.SubsampledArray.rst @@ -0,0 +1,67 @@ +.. currentmodule:: cf +.. default-role:: obj + +cf.SubsampledArray +================== + +---- + +.. autoclass:: cf.SubsampledArray + :no-members: + :no-inherited-members: + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.SubsampledArray.compressed_dimensions + ~cf.SubsampledArray.conformed_data + ~cf.SubsampledArray.copy + ~cf.SubsampledArray.get_attributes + ~cf.SubsampledArray.get_Subarray + ~cf.SubsampledArray.get_calendar + ~cf.SubsampledArray.get_compressed_axes + ~cf.SubsampledArray.get_compressed_dimension + ~cf.SubsampledArray.get_compression_type + ~cf.SubsampledArray.get_computational_precision + ~cf.SubsampledArray.get_dependent_tie_point_dimensions + ~cf.SubsampledArray.get_dependent_tie_points + ~cf.SubsampledArray.get_filenames + ~cf.SubsampledArray.get_interpolation_description + ~cf.SubsampledArray.get_interpolation_name + ~cf.SubsampledArray.get_parameter_dimensions + ~cf.SubsampledArray.get_parameters + ~cf.SubsampledArray.get_subspace + ~cf.SubsampledArray.get_tie_point_indices + ~cf.SubsampledArray.get_units + ~cf.SubsampledArray.set_dependent_tie_point_dimensions + ~cf.SubsampledArray.set_dependent_tie_points + ~cf.SubsampledArray.set_parameter_dimensions + ~cf.SubsampledArray.set_parameters + ~cf.SubsampledArray.set_tie_point_indices + ~cf.SubsampledArray.source + ~cf.SubsampledArray.subarray_parameters + ~cf.SubsampledArray.subarray_shapes + ~cf.SubsampledArray.subarrays + ~cf.SubsampledArray.to_dask_array + ~cf.SubsampledArray.to_memory + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.SubsampledArray.Units + ~cf.SubsampledArray.array + ~cf.SubsampledArray.bounds + ~cf.SubsampledArray.compressed_array + ~cf.SubsampledArray.dtype + ~cf.SubsampledArray.ndim + ~cf.SubsampledArray.shape + ~cf.SubsampledArray.size + diff --git a/docs/source/class/cf.UMArray.rst b/docs/source/class/cf.UMArray.rst new file mode 100644 index 0000000000..178e238952 --- /dev/null +++ b/docs/source/class/cf.UMArray.rst @@ -0,0 +1,144 @@ +.. currentmodule:: cf +.. default-role:: obj + +cf.UMArray +========== + +---- + +.. autoclass:: cf.UMArray + :no-members: + :no-inherited-members: + +Inspection +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.UMArray.get_compression_type + ~cf.UMArray.get_subspace + ~cf.UMArray.get_attributes + ~cf.UMArray.get_byte_ordering + ~cf.UMArray.get_fmt + ~cf.UMArray.get_word_size + ~cf.UMArray.get_mask + ~cf.UMArray.get_unpack + ~cf.UMArray.is_subspace + ~cf.UMArray.index + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.UMArray.array + ~cf.UMArray.dtype + ~cf.UMArray.ndim + ~cf.UMArray.shape + ~cf.UMArray.size + ~cf.UMArray.original_shape + ~cf.UMArray.reference_shape + +Units +----- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.UMArray.get_calendar + ~cf.UMArray.get_units + ~cf.UMArray.Units + +File +---- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.UMArray.get_address + ~cf.UMArray.get_addresses + ~cf.UMArray.close + ~cf.UMArray.open + ~cf.UMArray.get_filename + ~cf.UMArray.get_filenames + ~cf.UMArray.get_format + ~cf.UMArray.get_formats + ~cf.UMArray.get_storage_options + ~cf.UMArray.add_file_location + ~cf.UMArray.del_file_location + +Miscellaneous +------------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.UMArray.copy + ~cf.UMArray.to_memory + ~cf.UMArray.file_directory + ~cf.UMArray.replace_directory + ~cf.UMArray.replace_filename + +Special +------- + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.UMArray.__dask_tokenize__ + ~cf.UMArray.__getitem__ + +Docstring substitutions +----------------------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.UMArray._docstring_special_substitutions + ~cf.UMArray._docstring_substitutions + ~cf.UMArray._docstring_package_depth + ~cf.UMArray._docstring_method_exclusions + +Deprecated +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.UMArray.get_missing_values + ~cf.UMArray.byte_ordering + ~cf.UMArray.data_offset + ~cf.UMArray.file_locations + ~cf.UMArray.file_address + ~cf.UMArray.fmt + ~cf.UMArray.filename + ~cf.UMArray.disk_length + ~cf.UMArray.header_offset + ~cf.UMArray.word_size From e28e81ec866ee769565a682fe59fa2af1c84fe85 Mon Sep 17 00:00:00 2001 From: David Hassell Date: Tue, 11 Mar 2025 13:35:21 +0000 Subject: [PATCH 2/3] add missing docs --- docs/source/class/cf.CellConnectivity.rst | 763 +++++++++++++++------ docs/source/class/cf.DomainTopology.rst | 765 ++++++++++++++++------ docs/source/class/cf.FieldAncillary.rst | 1 - 3 files changed, 1140 insertions(+), 389 deletions(-) diff --git a/docs/source/class/cf.CellConnectivity.rst b/docs/source/class/cf.CellConnectivity.rst index d2c7605596..d425c05cf3 100644 --- a/docs/source/class/cf.CellConnectivity.rst +++ b/docs/source/class/cf.CellConnectivity.rst @@ -1,209 +1,584 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _cf-CellConnectivity: + cf.CellConnectivity -=================== +===================== -.. currentmodule:: cf +---- -.. autoclass:: CellConnectivity +.. autoclass:: cf.CellConnectivity + :no-members: + :no-inherited-members: - - .. automethod:: __init__ +Inspection +---------- - - .. rubric:: Methods +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.dump + ~cf.CellConnectivity.identity + ~cf.CellConnectivity.identities - .. autosummary:: +.. rubric:: Attributes - ~CellConnectivity.__init__ - ~CellConnectivity.all - ~CellConnectivity.allclose - ~CellConnectivity.any - ~CellConnectivity.apply_masking - ~CellConnectivity.arccos - ~CellConnectivity.arccosh - ~CellConnectivity.arcsin - ~CellConnectivity.arcsinh - ~CellConnectivity.arctan - ~CellConnectivity.arctanh - ~CellConnectivity.asdatetime - ~CellConnectivity.asreftime - ~CellConnectivity.ceil - ~CellConnectivity.chunk - ~CellConnectivity.clear_properties - ~CellConnectivity.clip - ~CellConnectivity.close - ~CellConnectivity.concatenate - ~CellConnectivity.convert_reference_time - ~CellConnectivity.copy - ~CellConnectivity.cos - ~CellConnectivity.cosh - ~CellConnectivity.count - ~CellConnectivity.count_masked - ~CellConnectivity.creation_commands - ~CellConnectivity.cyclic - ~CellConnectivity.datum - ~CellConnectivity.del_connectivity - ~CellConnectivity.del_data - ~CellConnectivity.del_properties - ~CellConnectivity.del_property - ~CellConnectivity.delprop - ~CellConnectivity.dump - ~CellConnectivity.equals - ~CellConnectivity.equivalent - ~CellConnectivity.exp - ~CellConnectivity.expand_dims - ~CellConnectivity.file_directories - ~CellConnectivity.fill_value - ~CellConnectivity.filled - ~CellConnectivity.flatten - ~CellConnectivity.flip - ~CellConnectivity.floor - ~CellConnectivity.get_connectivity - ~CellConnectivity.get_data - ~CellConnectivity.get_filenames - ~CellConnectivity.get_original_filenames - ~CellConnectivity.get_property - ~CellConnectivity.getprop - ~CellConnectivity.halo - ~CellConnectivity.has_bounds - ~CellConnectivity.has_connectivity - ~CellConnectivity.has_data - ~CellConnectivity.has_property - ~CellConnectivity.hasprop - ~CellConnectivity.identities - ~CellConnectivity.identity - ~CellConnectivity.insert_data - ~CellConnectivity.insert_dimension - ~CellConnectivity.inspect - ~CellConnectivity.iscyclic - ~CellConnectivity.log - ~CellConnectivity.mask_invalid - ~CellConnectivity.masked_invalid - ~CellConnectivity.match - ~CellConnectivity.match_by_identity - ~CellConnectivity.match_by_naxes - ~CellConnectivity.match_by_ncvar - ~CellConnectivity.match_by_property - ~CellConnectivity.match_by_units - ~CellConnectivity.max - ~CellConnectivity.maximum - ~CellConnectivity.mean - ~CellConnectivity.mid_range - ~CellConnectivity.min - ~CellConnectivity.minimum - ~CellConnectivity.name - ~CellConnectivity.nc_clear_hdf5_chunksizes - ~CellConnectivity.nc_clear_variable_groups - ~CellConnectivity.nc_del_variable - ~CellConnectivity.nc_get_variable - ~CellConnectivity.nc_has_variable - ~CellConnectivity.nc_hdf5_chunksizes - ~CellConnectivity.nc_set_hdf5_chunksizes - ~CellConnectivity.nc_set_variable - ~CellConnectivity.nc_set_variable_groups - ~CellConnectivity.nc_variable_groups - ~CellConnectivity.normalise - ~CellConnectivity.override_calendar - ~CellConnectivity.override_units - ~CellConnectivity.pad_missing - ~CellConnectivity.period - ~CellConnectivity.persist - ~CellConnectivity.properties - ~CellConnectivity.range - ~CellConnectivity.rechunk - ~CellConnectivity.remove_data - ~CellConnectivity.replace_directory - ~CellConnectivity.rint - ~CellConnectivity.roll - ~CellConnectivity.round - ~CellConnectivity.sample_size - ~CellConnectivity.sd - ~CellConnectivity.select - ~CellConnectivity.set_connectivity - ~CellConnectivity.set_data - ~CellConnectivity.set_properties - ~CellConnectivity.set_property - ~CellConnectivity.setprop - ~CellConnectivity.sin - ~CellConnectivity.sinh - ~CellConnectivity.squeeze - ~CellConnectivity.standard_deviation - ~CellConnectivity.sum - ~CellConnectivity.swapaxes - ~CellConnectivity.tan - ~CellConnectivity.tanh - ~CellConnectivity.to_dask_array - ~CellConnectivity.to_memory - ~CellConnectivity.transpose - ~CellConnectivity.trunc - ~CellConnectivity.uncompress - ~CellConnectivity.unique - ~CellConnectivity.var - ~CellConnectivity.variance - ~CellConnectivity.where +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.construct_type + +Topology +-------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.del_connectivity + ~cf.CellConnectivity.get_connectivity + ~cf.CellConnectivity.has_connectivity + ~cf.CellConnectivity.set_connectivity + ~cf.CellConnectivity.normalise + +.. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.connectivity + +Selection +--------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.match_by_identity + ~cf.CellConnectivity.match_by_naxes + ~cf.CellConnectivity.match_by_ncvar + ~cf.CellConnectivity.match_by_property + ~cf.CellConnectivity.match_by_units + +Properties +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.del_property + ~cf.CellConnectivity.get_property + ~cf.CellConnectivity.has_property + ~cf.CellConnectivity.set_property + ~cf.CellConnectivity.properties + ~cf.CellConnectivity.clear_properties + ~cf.CellConnectivity.del_properties + ~cf.CellConnectivity.set_properties + +.. rubric:: Attributes + +.. autosummary:: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.add_offset + ~cf.CellConnectivity.calendar + ~cf.CellConnectivity.comment + ~cf.CellConnectivity._FillValue + ~cf.CellConnectivity.history + ~cf.CellConnectivity.leap_month + ~cf.CellConnectivity.leap_year + ~cf.CellConnectivity.long_name + ~cf.CellConnectivity.missing_value + ~cf.CellConnectivity.month_lengths + ~cf.CellConnectivity.scale_factor + ~cf.CellConnectivity.standard_name + ~cf.CellConnectivity.units + ~cf.CellConnectivity.valid_max + ~cf.CellConnectivity.valid_min + ~cf.CellConnectivity.valid_range + +Units +----- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.override_units + ~cf.CellConnectivity.override_calendar + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.Units + +Data +---- + +.. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.array + ~cf.CellConnectivity.Data + ~cf.CellConnectivity.data + ~cf.CellConnectivity.datetime_array + ~cf.CellConnectivity.datum + ~cf.CellConnectivity.dtype + ~cf.CellConnectivity.isscalar + ~cf.CellConnectivity.ndim + ~cf.CellConnectivity.shape + ~cf.CellConnectivity.size + ~cf.CellConnectivity.varray + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + ~cf.CellConnectivity.to_dask_array + ~cf.CellConnectivity.__getitem__ + ~cf.CellConnectivity.del_data + ~cf.CellConnectivity.get_data + ~cf.CellConnectivity.has_data + ~cf.CellConnectivity.set_data + +.. rubric:: *Rearranging elements* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.flatten + ~cf.CellConnectivity.flip + ~cf.CellConnectivity.insert_dimension + ~cf.CellConnectivity.roll + ~cf.CellConnectivity.squeeze + ~cf.CellConnectivity.swapaxes + ~cf.CellConnectivity.transpose +.. rubric:: *Expanding the data* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.halo + ~cf.CellConnectivity.pad_missing + +.. rubric:: *Data array mask* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.apply_masking + ~cf.CellConnectivity.count + ~cf.CellConnectivity.count_masked + ~cf.CellConnectivity.fill_value + ~cf.CellConnectivity.filled + ~cf.CellConnectivity.masked_invalid + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.binary_mask + ~cf.CellConnectivity.hardmask + ~cf.CellConnectivity.mask + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + +.. rubric:: *Changing data values* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.__setitem__ + ~cf.CellConnectivity.masked_invalid + ~cf.CellConnectivity.subspace + ~cf.CellConnectivity.where + +.. rubric:: *Miscellaneous* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + + ~cf.CellConnectivity.rechunk + ~cf.CellConnectivity.close + ~cf.CellConnectivity.convert_reference_time + ~cf.CellConnectivity.cyclic + ~cf.CellConnectivity.period + ~cf.CellConnectivity.iscyclic + ~cf.CellConnectivity.isperiodic + ~cf.CellConnectivity.get_original_filenames + ~cf.CellConnectivity.has_bounds + ~cf.CellConnectivity.persist + +Miscellaneous +------------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.concatenate + ~cf.CellConnectivity.copy + ~cf.CellConnectivity.creation_commands + ~cf.CellConnectivity.equals + ~cf.CellConnectivity.to_memory + ~cf.CellConnectivity.uncompress + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: attribute.rst + + ~cf.CellConnectivity.T + ~cf.CellConnectivity.X + ~cf.CellConnectivity.Y + ~cf.CellConnectivity.Z + ~cf.CellConnectivity.id + +Mathematical operations +----------------------- + +.. http://docs.scipy.org/doc/numpy/reference/routines.math.html + +.. rubric:: Methods + +.. rubric:: *Trigonometrical and hyperbolic functions* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.arccos + ~cf.CellConnectivity.arccosh + ~cf.CellConnectivity.arcsin + ~cf.CellConnectivity.arcsinh + ~cf.CellConnectivity.arctan + .. ~cf.CellConnectivity.arctan2 [AT2] + ~cf.CellConnectivity.arctanh + ~cf.CellConnectivity.cos + ~cf.CellConnectivity.cosh + ~cf.CellConnectivity.sin + ~cf.CellConnectivity.sinh + ~cf.CellConnectivity.tan + ~cf.CellConnectivity.tanh + +.. rubric:: *Rounding and truncation* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.ceil + ~cf.CellConnectivity.clip + ~cf.CellConnectivity.floor + ~cf.CellConnectivity.rint + ~cf.CellConnectivity.round + ~cf.CellConnectivity.trunc + +.. rubric:: *Statistical collapses* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.max + ~cf.CellConnectivity.mean + ~cf.CellConnectivity.mid_range + ~cf.CellConnectivity.min + ~cf.CellConnectivity.range + ~cf.CellConnectivity.sample_size + ~cf.CellConnectivity.sum + ~cf.CellConnectivity.sd + ~cf.CellConnectivity.var + ~cf.CellConnectivity.standard_deviation + ~cf.CellConnectivity.variance + ~cf.CellConnectivity.maximum + ~cf.CellConnectivity.minimum + +.. rubric:: *Exponential and logarithmic functions* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.exp + ~cf.CellConnectivity.log + +Date-time operations +-------------------- + +.. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.day + ~cf.CellConnectivity.datetime_array + ~cf.CellConnectivity.hour + ~cf.CellConnectivity.minute + ~cf.CellConnectivity.month + ~cf.CellConnectivity.reference_datetime + ~cf.CellConnectivity.second + ~cf.CellConnectivity.year + +Logic functions +--------------- + +.. http://docs.scipy.org/doc/numpy/reference/routines.logic.html#truth-value-testing + +.. rubric:: Truth value testing + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.all + ~cf.CellConnectivity.any + +.. rubric:: Comparison + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.allclose + ~cf.CellConnectivity.equals + ~cf.CellConnectivity.equivalent + +.. rubric:: Set operations + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.unique + +NetCDF +------ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.nc_del_variable + ~cf.CellConnectivity.nc_get_variable + ~cf.CellConnectivity.nc_has_variable + ~cf.CellConnectivity.nc_set_variable + ~cf.CellConnectivity.nc_clear_hdf5_chunksizes + ~cf.CellConnectivity.nc_hdf5_chunksizes + ~cf.CellConnectivity.nc_set_hdf5_chunksizes + +Aggregation +----------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.file_directories + ~cf.CellConnectivity.replace_directory + +NetCDF +------ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.nc_del_variable + ~cf.CellConnectivity.nc_get_variable + ~cf.CellConnectivity.nc_has_variable + ~cf.CellConnectivity.nc_set_variable + +Groups +^^^^^^ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.nc_variable_groups + ~cf.CellConnectivity.nc_clear_variable_groups + ~cf.CellConnectivity.nc_set_variable_groups + +HDF5 chunks +^^^^^^^^^^^ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.nc_hdf5_chunksizes + ~cf.CellConnectivity.nc_set_hdf5_chunksizes + ~cf.CellConnectivity.nc_clear_hdf5_chunksizes + +Aliases +------- + +.. rubric:: Methods - .. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst - .. autosummary:: + ~cf.CellConnectivity.match + +.. rubric:: Attributes - ~CellConnectivity.Data - ~CellConnectivity.T - ~CellConnectivity.Units - ~CellConnectivity.X - ~CellConnectivity.Y - ~CellConnectivity.Z - ~CellConnectivity.add_offset - ~CellConnectivity.array - ~CellConnectivity.attributes - ~CellConnectivity.binary_mask - ~CellConnectivity.calendar - ~CellConnectivity.comment - ~CellConnectivity.connectivity - ~CellConnectivity.construct_type - ~CellConnectivity.data - ~CellConnectivity.datetime_array - ~CellConnectivity.day - ~CellConnectivity.dtarray - ~CellConnectivity.dtvarray - ~CellConnectivity.dtype - ~CellConnectivity.hardmask - ~CellConnectivity.hasbounds - ~CellConnectivity.hasdata - ~CellConnectivity.history - ~CellConnectivity.hour - ~CellConnectivity.id - ~CellConnectivity.isauxiliary - ~CellConnectivity.isdimension - ~CellConnectivity.isdomainancillary - ~CellConnectivity.isfieldancillary - ~CellConnectivity.ismeasure - ~CellConnectivity.isperiodic - ~CellConnectivity.isscalar - ~CellConnectivity.leap_month - ~CellConnectivity.leap_year - ~CellConnectivity.long_name - ~CellConnectivity.mask - ~CellConnectivity.minute - ~CellConnectivity.missing_value - ~CellConnectivity.month - ~CellConnectivity.month_lengths - ~CellConnectivity.ndim - ~CellConnectivity.reference_datetime - ~CellConnectivity.scale_factor - ~CellConnectivity.second - ~CellConnectivity.shape - ~CellConnectivity.size - ~CellConnectivity.standard_name - ~CellConnectivity.subspace - ~CellConnectivity.units - ~CellConnectivity.unsafe_array - ~CellConnectivity.valid_max - ~CellConnectivity.valid_min - ~CellConnectivity.valid_range - ~CellConnectivity.varray - ~CellConnectivity.year +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.CellConnectivity.dtarray - \ No newline at end of file +Special +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.__deepcopy__ + ~cf.CellConnectivity.__getitem__ + ~cf.CellConnectivity.__repr__ + ~cf.CellConnectivity.__str__ + +Docstring substitutions +----------------------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity._docstring_special_substitutions + ~cf.CellConnectivity._docstring_substitutions + ~cf.CellConnectivity._docstring_package_depth + ~cf.CellConnectivity._docstring_method_exclusions + +Deprecated +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.CellConnectivity.add_file_location + ~cf.CellConnectivity.asdatetime + ~cf.CellConnectivity.asreftime + ~cf.CellConnectivity.attributes + ~cf.CellConnectivity.cfa_clear_file_substitutions + ~cf.CellConnectivity.cfa_del_file_substitution + ~cf.CellConnectivity.cfa_file_substitutions + ~cf.CellConnectivity.cfa_update_file_substitutions + ~cf.CellConnectivity.chunk + ~cf.CellConnectivity.del_file_location + ~cf.CellConnectivity.delprop + ~cf.CellConnectivity.dtvarray + ~cf.CellConnectivity.expand_dims + ~cf.CellConnectivity.get_filenames + ~cf.CellConnectivity.file_locations + ~cf.CellConnectivity.getprop + ~cf.CellConnectivity.hasbounds + ~cf.CellConnectivity.hasdata + ~cf.CellConnectivity.hasprop + ~cf.CellConnectivity.insert_data + ~cf.CellConnectivity.isauxiliary + ~cf.CellConnectivity.isdimension + ~cf.CellConnectivity.isdomainancillary + ~cf.CellConnectivity.isfieldancillary + ~cf.CellConnectivity.ismeasure + ~cf.CellConnectivity.mask_invalid + ~cf.CellConnectivity.name + ~cf.CellConnectivity.remove_data + ~cf.CellConnectivity.select + ~cf.CellConnectivity.setprop + ~cf.CellConnectivity.unsafe_array diff --git a/docs/source/class/cf.DomainTopology.rst b/docs/source/class/cf.DomainTopology.rst index 2b2402f7d6..a9b7d7bd32 100644 --- a/docs/source/class/cf.DomainTopology.rst +++ b/docs/source/class/cf.DomainTopology.rst @@ -1,209 +1,586 @@ +.. currentmodule:: cf +.. default-role:: obj + +.. _cf-DomainTopology: + cf.DomainTopology -================= +=================== -.. currentmodule:: cf +---- -.. autoclass:: DomainTopology +.. autoclass:: cf.DomainTopology + :no-members: + :no-inherited-members: - - .. automethod:: __init__ +Inspection +---------- - - .. rubric:: Methods +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst - .. autosummary:: + ~cf.DomainTopology.dump + ~cf.DomainTopology.identity + ~cf.DomainTopology.identities + ~cf.DomainTopology.inspect - ~DomainTopology.__init__ - ~DomainTopology.all - ~DomainTopology.allclose - ~DomainTopology.any - ~DomainTopology.apply_masking - ~DomainTopology.arccos - ~DomainTopology.arccosh - ~DomainTopology.arcsin - ~DomainTopology.arcsinh - ~DomainTopology.arctan - ~DomainTopology.arctanh - ~DomainTopology.asdatetime - ~DomainTopology.asreftime - ~DomainTopology.ceil - ~DomainTopology.chunk - ~DomainTopology.clear_properties - ~DomainTopology.clip - ~DomainTopology.close - ~DomainTopology.concatenate - ~DomainTopology.convert_reference_time - ~DomainTopology.copy - ~DomainTopology.cos - ~DomainTopology.cosh - ~DomainTopology.count - ~DomainTopology.count_masked - ~DomainTopology.creation_commands - ~DomainTopology.cyclic - ~DomainTopology.datum - ~DomainTopology.del_cell - ~DomainTopology.del_data - ~DomainTopology.del_properties - ~DomainTopology.del_property - ~DomainTopology.delprop - ~DomainTopology.dump - ~DomainTopology.equals - ~DomainTopology.equivalent - ~DomainTopology.exp - ~DomainTopology.expand_dims - ~DomainTopology.file_directories - ~DomainTopology.fill_value - ~DomainTopology.filled - ~DomainTopology.flatten - ~DomainTopology.flip - ~DomainTopology.floor - ~DomainTopology.get_cell - ~DomainTopology.get_data - ~DomainTopology.get_filenames - ~DomainTopology.get_original_filenames - ~DomainTopology.get_property - ~DomainTopology.getprop - ~DomainTopology.halo - ~DomainTopology.has_bounds - ~DomainTopology.has_cell - ~DomainTopology.has_data - ~DomainTopology.has_property - ~DomainTopology.hasprop - ~DomainTopology.identities - ~DomainTopology.identity - ~DomainTopology.insert_data - ~DomainTopology.insert_dimension - ~DomainTopology.inspect - ~DomainTopology.iscyclic - ~DomainTopology.log - ~DomainTopology.mask_invalid - ~DomainTopology.masked_invalid - ~DomainTopology.match - ~DomainTopology.match_by_identity - ~DomainTopology.match_by_naxes - ~DomainTopology.match_by_ncvar - ~DomainTopology.match_by_property - ~DomainTopology.match_by_units - ~DomainTopology.max - ~DomainTopology.maximum - ~DomainTopology.mean - ~DomainTopology.mid_range - ~DomainTopology.min - ~DomainTopology.minimum - ~DomainTopology.name - ~DomainTopology.nc_clear_hdf5_chunksizes - ~DomainTopology.nc_clear_variable_groups - ~DomainTopology.nc_del_variable - ~DomainTopology.nc_get_variable - ~DomainTopology.nc_has_variable - ~DomainTopology.nc_hdf5_chunksizes - ~DomainTopology.nc_set_hdf5_chunksizes - ~DomainTopology.nc_set_variable - ~DomainTopology.nc_set_variable_groups - ~DomainTopology.nc_variable_groups - ~DomainTopology.normalise - ~DomainTopology.override_calendar - ~DomainTopology.override_units - ~DomainTopology.pad_missing - ~DomainTopology.period - ~DomainTopology.persist - ~DomainTopology.properties - ~DomainTopology.range - ~DomainTopology.rechunk - ~DomainTopology.remove_data - ~DomainTopology.replace_directory - ~DomainTopology.rint - ~DomainTopology.roll - ~DomainTopology.round - ~DomainTopology.sample_size - ~DomainTopology.sd - ~DomainTopology.select - ~DomainTopology.set_cell - ~DomainTopology.set_data - ~DomainTopology.set_properties - ~DomainTopology.set_property - ~DomainTopology.setprop - ~DomainTopology.sin - ~DomainTopology.sinh - ~DomainTopology.squeeze - ~DomainTopology.standard_deviation - ~DomainTopology.sum - ~DomainTopology.swapaxes - ~DomainTopology.tan - ~DomainTopology.tanh - ~DomainTopology.to_dask_array - ~DomainTopology.to_memory - ~DomainTopology.transpose - ~DomainTopology.trunc - ~DomainTopology.uncompress - ~DomainTopology.unique - ~DomainTopology.var - ~DomainTopology.variance - ~DomainTopology.where +.. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.construct_type + ~cf.DomainTopology.id + +Topology +-------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.del_cell + ~cf.DomainTopology.get_cell + ~cf.DomainTopology.has_cell + ~cf.DomainTopology.set_cell + ~cf.DomainTopology.normalise + +.. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.cell + +Selection +--------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + ~cf.DomainTopology.match_by_identity + ~cf.DomainTopology.match_by_naxes + ~cf.DomainTopology.match_by_ncvar + ~cf.DomainTopology.match_by_property + ~cf.DomainTopology.match_by_units + +Properties +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.del_property + ~cf.DomainTopology.get_property + ~cf.DomainTopology.has_property + ~cf.DomainTopology.set_property + ~cf.DomainTopology.properties + ~cf.DomainTopology.clear_properties + ~cf.DomainTopology.del_properties + ~cf.DomainTopology.set_properties + +.. rubric:: Attributes + +.. autosummary:: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.add_offset + ~cf.DomainTopology.calendar + ~cf.DomainTopology.comment + ~cf.DomainTopology._FillValue + ~cf.DomainTopology.history + ~cf.DomainTopology.leap_month + ~cf.DomainTopology.leap_year + ~cf.DomainTopology.long_name + ~cf.DomainTopology.missing_value + ~cf.DomainTopology.month_lengths + ~cf.DomainTopology.scale_factor + ~cf.DomainTopology.standard_name + ~cf.DomainTopology.units + ~cf.DomainTopology.valid_max + ~cf.DomainTopology.valid_min + ~cf.DomainTopology.valid_range + +Units +----- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.override_units + ~cf.DomainTopology.override_calendar + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.Units + +Data +---- + +.. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.array + ~cf.DomainTopology.Data + ~cf.DomainTopology.data + ~cf.DomainTopology.datetime_array + ~cf.DomainTopology.datum + ~cf.DomainTopology.dtype + ~cf.DomainTopology.isscalar + ~cf.DomainTopology.ndim + ~cf.DomainTopology.shape + ~cf.DomainTopology.size + ~cf.DomainTopology.varray + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.to_dask_array + ~cf.DomainTopology.__getitem__ + ~cf.DomainTopology.del_data + ~cf.DomainTopology.get_data + ~cf.DomainTopology.has_data + ~cf.DomainTopology.set_data + +.. rubric:: *Rearranging elements* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.flatten + ~cf.DomainTopology.flip + ~cf.DomainTopology.insert_dimension + ~cf.DomainTopology.roll + ~cf.DomainTopology.squeeze + ~cf.DomainTopology.swapaxes + ~cf.DomainTopology.transpose - .. rubric:: Attributes +.. rubric:: *Expanding the data* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.halo + ~cf.DomainTopology.pad_missing + +.. rubric:: *Data array mask* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.apply_masking + ~cf.DomainTopology.count + ~cf.DomainTopology.count_masked + ~cf.DomainTopology.fill_value + ~cf.DomainTopology.filled + ~cf.DomainTopology.masked_invalid + +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.binary_mask + ~cf.DomainTopology.hardmask + ~cf.DomainTopology.mask + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + +.. rubric:: *Changing data values* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.__setitem__ + ~cf.DomainTopology.masked_invalid + ~cf.DomainTopology.subspace + ~cf.DomainTopology.where + +.. rubric:: *Miscellaneous* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + + ~cf.DomainTopology.rechunk + ~cf.DomainTopology.close + ~cf.DomainTopology.convert_reference_time + ~cf.DomainTopology.cyclic + ~cf.DomainTopology.period + ~cf.DomainTopology.iscyclic + ~cf.DomainTopology.isperiodic + ~cf.DomainTopology.get_original_filenames + ~cf.DomainTopology.has_bounds + ~cf.DomainTopology.persist + +Miscellaneous +------------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.concatenate + ~cf.DomainTopology.copy + ~cf.DomainTopology.creation_commands + ~cf.DomainTopology.equals + ~cf.DomainTopology.to_memory + ~cf.DomainTopology.uncompress + +.. rubric:: Attributes + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: attribute.rst + + ~cf.DomainTopology.T + ~cf.DomainTopology.X + ~cf.DomainTopology.Y + ~cf.DomainTopology.Z + ~cf.DomainTopology.id + +Mathematical operations +----------------------- + +.. http://docs.scipy.org/doc/numpy/reference/routines.math.html + +.. rubric:: Methods - .. autosummary:: +.. rubric:: *Trigonometrical and hyperbolic functions* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.arccos + ~cf.DomainTopology.arccosh + ~cf.DomainTopology.arcsin + ~cf.DomainTopology.arcsinh + ~cf.DomainTopology.arctan + .. ~cf.DomainTopology.arctan2 [AT2] + ~cf.DomainTopology.arctanh + ~cf.DomainTopology.cos + ~cf.DomainTopology.cosh + ~cf.DomainTopology.sin + ~cf.DomainTopology.sinh + ~cf.DomainTopology.tan + ~cf.DomainTopology.tanh + +.. rubric:: *Rounding and truncation* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.ceil + ~cf.DomainTopology.clip + ~cf.DomainTopology.floor + ~cf.DomainTopology.rint + ~cf.DomainTopology.round + ~cf.DomainTopology.trunc + +.. rubric:: *Statistical collapses* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.max + ~cf.DomainTopology.mean + ~cf.DomainTopology.mid_range + ~cf.DomainTopology.min + ~cf.DomainTopology.range + ~cf.DomainTopology.sample_size + ~cf.DomainTopology.sum + ~cf.DomainTopology.sd + ~cf.DomainTopology.var + ~cf.DomainTopology.standard_deviation + ~cf.DomainTopology.variance + ~cf.DomainTopology.maximum + ~cf.DomainTopology.minimum + +.. rubric:: *Exponential and logarithmic functions* + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.exp + ~cf.DomainTopology.log + +Date-time operations +-------------------- + +.. rubric:: Attributes +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.day + ~cf.DomainTopology.datetime_array + ~cf.DomainTopology.hour + ~cf.DomainTopology.minute + ~cf.DomainTopology.month + ~cf.DomainTopology.reference_datetime + ~cf.DomainTopology.second + ~cf.DomainTopology.year + +Logic functions +--------------- + +.. http://docs.scipy.org/doc/numpy/reference/routines.logic.html#truth-value-testing + +.. rubric:: Truth value testing + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.all + ~cf.DomainTopology.any + +.. rubric:: Comparison + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.allclose + ~cf.DomainTopology.equals + ~cf.DomainTopology.equivalent + +.. rubric:: Set operations + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.unique + +NetCDF +------ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.nc_del_variable + ~cf.DomainTopology.nc_get_variable + ~cf.DomainTopology.nc_has_variable + ~cf.DomainTopology.nc_set_variable + ~cf.DomainTopology.nc_clear_hdf5_chunksizes + ~cf.DomainTopology.nc_hdf5_chunksizes + ~cf.DomainTopology.nc_set_hdf5_chunksizes + +Aggregation +----------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.file_directories + ~cf.DomainTopology.replace_directory + +NetCDF +------ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.nc_del_variable + ~cf.DomainTopology.nc_get_variable + ~cf.DomainTopology.nc_has_variable + ~cf.DomainTopology.nc_set_variable + +Groups +^^^^^^ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.nc_variable_groups + ~cf.DomainTopology.nc_clear_variable_groups + ~cf.DomainTopology.nc_set_variable_groups + +HDF5 chunks +^^^^^^^^^^^ + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.nc_hdf5_chunksizes + ~cf.DomainTopology.nc_set_hdf5_chunksizes + ~cf.DomainTopology.nc_clear_hdf5_chunksizes + +Aliases +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.match + +.. rubric:: Attributes - ~DomainTopology.Data - ~DomainTopology.T - ~DomainTopology.Units - ~DomainTopology.X - ~DomainTopology.Y - ~DomainTopology.Z - ~DomainTopology.add_offset - ~DomainTopology.array - ~DomainTopology.attributes - ~DomainTopology.binary_mask - ~DomainTopology.calendar - ~DomainTopology.cell - ~DomainTopology.comment - ~DomainTopology.construct_type - ~DomainTopology.data - ~DomainTopology.datetime_array - ~DomainTopology.day - ~DomainTopology.dtarray - ~DomainTopology.dtvarray - ~DomainTopology.dtype - ~DomainTopology.hardmask - ~DomainTopology.hasbounds - ~DomainTopology.hasdata - ~DomainTopology.history - ~DomainTopology.hour - ~DomainTopology.id - ~DomainTopology.isauxiliary - ~DomainTopology.isdimension - ~DomainTopology.isdomainancillary - ~DomainTopology.isfieldancillary - ~DomainTopology.ismeasure - ~DomainTopology.isperiodic - ~DomainTopology.isscalar - ~DomainTopology.leap_month - ~DomainTopology.leap_year - ~DomainTopology.long_name - ~DomainTopology.mask - ~DomainTopology.minute - ~DomainTopology.missing_value - ~DomainTopology.month - ~DomainTopology.month_lengths - ~DomainTopology.ndim - ~DomainTopology.reference_datetime - ~DomainTopology.scale_factor - ~DomainTopology.second - ~DomainTopology.shape - ~DomainTopology.size - ~DomainTopology.standard_name - ~DomainTopology.subspace - ~DomainTopology.units - ~DomainTopology.unsafe_array - ~DomainTopology.valid_max - ~DomainTopology.valid_min - ~DomainTopology.valid_range - ~DomainTopology.varray - ~DomainTopology.year +.. autosummary:: + :nosignatures: + :toctree: ../attribute/ + :template: attribute.rst + + ~cf.DomainTopology.dtarray - \ No newline at end of file +Special +------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.__deepcopy__ + ~cf.DomainTopology.__getitem__ + ~cf.DomainTopology.__repr__ + ~cf.DomainTopology.__str__ + +Docstring substitutions +----------------------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology._docstring_special_substitutions + ~cf.DomainTopology._docstring_substitutions + ~cf.DomainTopology._docstring_package_depth + ~cf.DomainTopology._docstring_method_exclusions + +Deprecated +---------- + +.. rubric:: Methods + +.. autosummary:: + :nosignatures: + :toctree: ../method/ + :template: method.rst + + ~cf.DomainTopology.add_file_location + ~cf.DomainTopology.asdatetime + ~cf.DomainTopology.asreftime + ~cf.DomainTopology.attributes + ~cf.DomainTopology.cfa_clear_file_substitutions + ~cf.DomainTopology.cfa_del_file_substitution + ~cf.DomainTopology.cfa_file_substitutions + ~cf.DomainTopology.cfa_update_file_substitutions + ~cf.DomainTopology.chunk + ~cf.DomainTopology.del_file_location + ~cf.DomainTopology.delprop + ~cf.DomainTopology.dtvarray + ~cf.DomainTopology.expand_dims + ~cf.DomainTopology.get_filenames + ~cf.DomainTopology.file_locations + ~cf.DomainTopology.getprop + ~cf.DomainTopology.hasbounds + ~cf.DomainTopology.hasdata + ~cf.DomainTopology.hasprop + ~cf.DomainTopology.insert_data + ~cf.DomainTopology.isauxiliary + ~cf.DomainTopology.isdimension + ~cf.DomainTopology.isdomainancillary + ~cf.DomainTopology.isfieldancillary + ~cf.DomainTopology.ismeasure + ~cf.DomainTopology.mask_invalid + ~cf.DomainTopology.name + ~cf.DomainTopology.remove_data + ~cf.DomainTopology.select + ~cf.DomainTopology.setprop + ~cf.DomainTopology.unsafe_array diff --git a/docs/source/class/cf.FieldAncillary.rst b/docs/source/class/cf.FieldAncillary.rst index 089654a4dd..e83f3c2eae 100644 --- a/docs/source/class/cf.FieldAncillary.rst +++ b/docs/source/class/cf.FieldAncillary.rst @@ -117,7 +117,6 @@ Units ~cf.FieldAncillary.Units - Data ---- From a9ada6c9215e606c7816f24f8f73890901137b96 Mon Sep 17 00:00:00 2001 From: David Hassell Date: Tue, 11 Mar 2025 13:59:01 +0000 Subject: [PATCH 3/3] add missing docs --- cf/domain.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/cf/domain.py b/cf/domain.py index 6ab754f18b..98ca769cdb 100644 --- a/cf/domain.py +++ b/cf/domain.py @@ -1,5 +1,4 @@ from math import prod -from os import sep import cfdm import numpy as np @@ -14,7 +13,6 @@ from .functions import ( _DEPRECATION_ERROR_ARG, _DEPRECATION_ERROR_METHOD, - abspath, indices_shape, parse_indices, )