Skip to content

Commit ddd8d23

Browse files
sadielbartholomewsadielbartholomew
committed
Add 4 missing files as new API ref. class stubs w/ methods populated
1 parent 19bc630 commit ddd8d23

4 files changed

Lines changed: 349 additions & 0 deletions

File tree

‎docs/source/class/cf.AggregatedArray.rst‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
.. currentmodule:: cf
2+
.. default-role:: obj
3+
4+
.. _aggregatedarray:
5+
6+
cf.AggregatedArray
7+
==================
8+
9+
----
10+
11+
.. autoclass:: cf.AggregatedArray
12+
:no-members:
13+
:no-inherited-members:
14+
15+
Methods
16+
-------
17+
18+
.. rubric:: Methods
19+
20+
.. autosummary::
21+
:nosignatures:
22+
:toctree: ../method/
23+
:template: method.rst
24+
25+
~cf.AggregatedArray.Units
26+
~cf.AggregatedArray.array
27+
~cf.AggregatedArray.astype
28+
~cf.AggregatedArray.close
29+
~cf.AggregatedArray.copy
30+
~cf.AggregatedArray.dtype
31+
~cf.AggregatedArray.file_directory
32+
~cf.AggregatedArray.get_address
33+
~cf.AggregatedArray.get_attributes
34+
~cf.AggregatedArray.get_calendar
35+
~cf.AggregatedArray.get_compression_type
36+
~cf.AggregatedArray.get_filename
37+
~cf.AggregatedArray.get_fragment_array
38+
~cf.AggregatedArray.get_fragment_array_shape
39+
~cf.AggregatedArray.get_fragment_type
40+
~cf.AggregatedArray.get_fragmented_dimensions
41+
~cf.AggregatedArray.get_mask
42+
~cf.AggregatedArray.get_missing_values
43+
~cf.AggregatedArray.get_storage_options
44+
~cf.AggregatedArray.get_storage_protocol
45+
~cf.AggregatedArray.get_units
46+
~cf.AggregatedArray.get_unpack
47+
~cf.AggregatedArray.get_variable
48+
~cf.AggregatedArray.has_remote_storage_protocol
49+
~cf.AggregatedArray.ndim
50+
~cf.AggregatedArray.open
51+
~cf.AggregatedArray.replace_directory
52+
~cf.AggregatedArray.replace_filename
53+
~cf.AggregatedArray.shape
54+
~cf.AggregatedArray.size
55+
~cf.AggregatedArray.subarray_shapes
56+
~cf.AggregatedArray.subarrays
57+
~cf.AggregatedArray.to_dask_array
58+
~cf.AggregatedArray.to_memory

‎docs/source/class/cf.CFImplementation.rst‎

Lines changed: 218 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,218 @@
1+
.. currentmodule:: cf
2+
.. default-role:: obj
3+
4+
.. _cfimplementation:
5+
6+
cf.CFImplementation
7+
===================
8+
9+
----
10+
11+
.. autoclass:: cf.CFImplementation
12+
:no-members:
13+
:no-inherited-members:
14+
15+
Methods
16+
-------
17+
18+
.. rubric:: Methods
19+
20+
.. autosummary::
21+
:nosignatures:
22+
:toctree: ../method/
23+
:template: method.rst
24+
25+
~cf.CFImplementation.bounds_insert_dimension
26+
~cf.CFImplementation.classes
27+
~cf.CFImplementation.climatological_time_axes
28+
~cf.CFImplementation.conform_geometry_variables
29+
~cf.CFImplementation.construct_insert_dimension
30+
~cf.CFImplementation.convert
31+
~cf.CFImplementation.copy
32+
~cf.CFImplementation.copy_construct
33+
~cf.CFImplementation.data_insert_dimension
34+
~cf.CFImplementation.del_parameter
35+
~cf.CFImplementation.del_properties
36+
~cf.CFImplementation.del_property
37+
~cf.CFImplementation.equal_components
38+
~cf.CFImplementation.equal_constructs
39+
~cf.CFImplementation.equal_datums
40+
~cf.CFImplementation.equal_properties
41+
~cf.CFImplementation.field_insert_dimension
42+
~cf.CFImplementation.get_array
43+
~cf.CFImplementation.get_auxiliary_coordinates
44+
~cf.CFImplementation.get_bounds
45+
~cf.CFImplementation.get_bounds_ncvar
46+
~cf.CFImplementation.get_cell_connectivities
47+
~cf.CFImplementation.get_cell_measures
48+
~cf.CFImplementation.get_cell_method_axes
49+
~cf.CFImplementation.get_cell_method_qualifiers
50+
~cf.CFImplementation.get_cell_method_string
51+
~cf.CFImplementation.get_cell_methods
52+
~cf.CFImplementation.get_cf_version
53+
~cf.CFImplementation.get_class
54+
~cf.CFImplementation.get_compressed_array
55+
~cf.CFImplementation.get_compressed_axes
56+
~cf.CFImplementation.get_compression_type
57+
~cf.CFImplementation.get_construct_data_axes
58+
~cf.CFImplementation.get_construct_data_size
59+
~cf.CFImplementation.get_construct_type
60+
~cf.CFImplementation.get_constructs
61+
~cf.CFImplementation.get_coordinate_conversion_parameters
62+
~cf.CFImplementation.get_coordinate_reference_coordinates
63+
~cf.CFImplementation.get_coordinate_references
64+
~cf.CFImplementation.get_coordinates
65+
~cf.CFImplementation.get_count
66+
~cf.CFImplementation.get_data
67+
~cf.CFImplementation.get_data_axes
68+
~cf.CFImplementation.get_data_calendar
69+
~cf.CFImplementation.get_data_compressed_axes
70+
~cf.CFImplementation.get_data_max
71+
~cf.CFImplementation.get_data_maximum
72+
~cf.CFImplementation.get_data_ndim
73+
~cf.CFImplementation.get_data_shape
74+
~cf.CFImplementation.get_data_size
75+
~cf.CFImplementation.get_data_source
76+
~cf.CFImplementation.get_data_sum
77+
~cf.CFImplementation.get_data_units
78+
~cf.CFImplementation.get_datum
79+
~cf.CFImplementation.get_datum_parameters
80+
~cf.CFImplementation.get_dimension_coordinates
81+
~cf.CFImplementation.get_domain_ancillaries
82+
~cf.CFImplementation.get_domain_axes
83+
~cf.CFImplementation.get_domain_axis_size
84+
~cf.CFImplementation.get_domain_topologies
85+
~cf.CFImplementation.get_field_ancillaries
86+
~cf.CFImplementation.get_field_data_axes
87+
~cf.CFImplementation.get_filenames
88+
~cf.CFImplementation.get_geometry
89+
~cf.CFImplementation.get_index
90+
~cf.CFImplementation.get_inherited_properties
91+
~cf.CFImplementation.get_interior_ring
92+
~cf.CFImplementation.get_interpolation_name
93+
~cf.CFImplementation.get_list
94+
~cf.CFImplementation.get_measure
95+
~cf.CFImplementation.get_node_count
96+
~cf.CFImplementation.get_original_filenames
97+
~cf.CFImplementation.get_parameter
98+
~cf.CFImplementation.get_part_node_count
99+
~cf.CFImplementation.get_properties
100+
~cf.CFImplementation.get_property
101+
~cf.CFImplementation.get_quantization
102+
~cf.CFImplementation.get_quantize_on_write
103+
~cf.CFImplementation.get_sample_dimension_position
104+
~cf.CFImplementation.get_tie_points
105+
~cf.CFImplementation.has_bounds
106+
~cf.CFImplementation.has_datum
107+
~cf.CFImplementation.has_domain_topology
108+
~cf.CFImplementation.has_property
109+
~cf.CFImplementation.initialise_AggregatedArray
110+
~cf.CFImplementation.initialise_AuxiliaryCoordinate
111+
~cf.CFImplementation.initialise_Bounds
112+
~cf.CFImplementation.initialise_BoundsFromNodesArray
113+
~cf.CFImplementation.initialise_CellConnectivity
114+
~cf.CFImplementation.initialise_CellConnectivityArray
115+
~cf.CFImplementation.initialise_CellMeasure
116+
~cf.CFImplementation.initialise_CellMethod
117+
~cf.CFImplementation.initialise_CoordinateConversion
118+
~cf.CFImplementation.initialise_CoordinateReference
119+
~cf.CFImplementation.initialise_Count
120+
~cf.CFImplementation.initialise_Data
121+
~cf.CFImplementation.initialise_Datum
122+
~cf.CFImplementation.initialise_DimensionCoordinate
123+
~cf.CFImplementation.initialise_DimensionCoordinate_from_AuxiliaryCoordinate
124+
~cf.CFImplementation.initialise_Domain
125+
~cf.CFImplementation.initialise_DomainAncillary
126+
~cf.CFImplementation.initialise_DomainAxis
127+
~cf.CFImplementation.initialise_DomainTopology
128+
~cf.CFImplementation.initialise_Field
129+
~cf.CFImplementation.initialise_FieldAncillary
130+
~cf.CFImplementation.initialise_GatheredArray
131+
~cf.CFImplementation.initialise_H5netcdfArray
132+
~cf.CFImplementation.initialise_Index
133+
~cf.CFImplementation.initialise_InteriorRing
134+
~cf.CFImplementation.initialise_InterpolationParameter
135+
~cf.CFImplementation.initialise_List
136+
~cf.CFImplementation.initialise_NetCDF4Array
137+
~cf.CFImplementation.initialise_NodeCountProperties
138+
~cf.CFImplementation.initialise_PartNodeCount
139+
~cf.CFImplementation.initialise_PointTopologyArray
140+
~cf.CFImplementation.initialise_PyfiveArray
141+
~cf.CFImplementation.initialise_Quantization
142+
~cf.CFImplementation.initialise_RaggedContiguousArray
143+
~cf.CFImplementation.initialise_RaggedIndexedArray
144+
~cf.CFImplementation.initialise_RaggedIndexedContiguousArray
145+
~cf.CFImplementation.initialise_ScipyNetcdfFileArray
146+
~cf.CFImplementation.initialise_SubsampledArray
147+
~cf.CFImplementation.initialise_TiePointIndex
148+
~cf.CFImplementation.initialise_ZarrArray
149+
~cf.CFImplementation.is_climatology
150+
~cf.CFImplementation.is_domain
151+
~cf.CFImplementation.is_field
152+
~cf.CFImplementation.is_geometry
153+
~cf.CFImplementation.is_masked
154+
~cf.CFImplementation.nc_get_dataset_chunksizes
155+
~cf.CFImplementation.nc_get_dataset_shards
156+
~cf.CFImplementation.nc_get_datum_variable
157+
~cf.CFImplementation.nc_get_dimension
158+
~cf.CFImplementation.nc_get_external
159+
~cf.CFImplementation.nc_get_geometry_variable
160+
~cf.CFImplementation.nc_get_global_attributes
161+
~cf.CFImplementation.nc_get_group_attributes
162+
~cf.CFImplementation.nc_get_hdf5_chunksizes
163+
~cf.CFImplementation.nc_get_sample_dimension
164+
~cf.CFImplementation.nc_get_variable
165+
~cf.CFImplementation.nc_get_variable_groups
166+
~cf.CFImplementation.nc_is_unlimited_axis
167+
~cf.CFImplementation.nc_set_dataset_chunksizes
168+
~cf.CFImplementation.nc_set_dataset_shards
169+
~cf.CFImplementation.nc_set_datum_variable
170+
~cf.CFImplementation.nc_set_dimension
171+
~cf.CFImplementation.nc_set_external
172+
~cf.CFImplementation.nc_set_geometry_variable
173+
~cf.CFImplementation.nc_set_global_attributes
174+
~cf.CFImplementation.nc_set_group_attributes
175+
~cf.CFImplementation.nc_set_hdf5_chunksizes
176+
~cf.CFImplementation.nc_set_instance_dimension
177+
~cf.CFImplementation.nc_set_interpolation_subarea_dimension
178+
~cf.CFImplementation.nc_set_node_coordinate_variable
179+
~cf.CFImplementation.nc_set_sample_dimension
180+
~cf.CFImplementation.nc_set_subsampled_dimension
181+
~cf.CFImplementation.nc_set_unlimited_axis
182+
~cf.CFImplementation.nc_set_variable
183+
~cf.CFImplementation.parameters
184+
~cf.CFImplementation.set_auxiliary_coordinate
185+
~cf.CFImplementation.set_bounds
186+
~cf.CFImplementation.set_cell_connectivity
187+
~cf.CFImplementation.set_cell_measure
188+
~cf.CFImplementation.set_cell_method
189+
~cf.CFImplementation.set_cell_method_axes
190+
~cf.CFImplementation.set_cell_method_method
191+
~cf.CFImplementation.set_class
192+
~cf.CFImplementation.set_climatology
193+
~cf.CFImplementation.set_construct
194+
~cf.CFImplementation.set_coordinate_conversion
195+
~cf.CFImplementation.set_coordinate_reference
196+
~cf.CFImplementation.set_coordinate_reference_coordinate
197+
~cf.CFImplementation.set_coordinate_reference_coordinates
198+
~cf.CFImplementation.set_data
199+
~cf.CFImplementation.set_dataset_compliance
200+
~cf.CFImplementation.set_datum
201+
~cf.CFImplementation.set_dependent_tie_points
202+
~cf.CFImplementation.set_dimension_coordinate
203+
~cf.CFImplementation.set_domain_ancillary
204+
~cf.CFImplementation.set_domain_axis
205+
~cf.CFImplementation.set_domain_topology
206+
~cf.CFImplementation.set_field_ancillary
207+
~cf.CFImplementation.set_geometry
208+
~cf.CFImplementation.set_inherited_properties
209+
~cf.CFImplementation.set_interior_ring
210+
~cf.CFImplementation.set_interpolation
211+
~cf.CFImplementation.set_node_count_properties
212+
~cf.CFImplementation.set_original_filenames
213+
~cf.CFImplementation.set_parameter
214+
~cf.CFImplementation.set_part_node_count_properties
215+
~cf.CFImplementation.set_properties
216+
~cf.CFImplementation.set_quantization
217+
~cf.CFImplementation.squeeze
218+
~cf.CFImplementation.unsqueeze

‎docs/source/class/cf.ConstructList.rst‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
.. currentmodule:: cf
2+
.. default-role:: obj
3+
4+
.. _interiorring:
5+
6+
cf.ConstructList
7+
================
8+
9+
----
10+
11+
.. autoclass:: cf.ConstructList
12+
:no-members:
13+
:no-inherited-members:
14+
15+
Methods
16+
-------
17+
18+
.. rubric:: Methods
19+
20+
.. autosummary::
21+
:nosignatures:
22+
:toctree: ../method/
23+
:template: method.rst
24+
25+
~cf.ConstructList.append
26+
~cf.ConstructList.clear
27+
~cf.ConstructList.close
28+
~cf.ConstructList.copy
29+
~cf.ConstructList.count
30+
~cf.ConstructList.equals
31+
~cf.ConstructList.extend
32+
~cf.ConstructList.index
33+
~cf.ConstructList.insert
34+
~cf.ConstructList.pop
35+
~cf.ConstructList.remove
36+
~cf.ConstructList.reverse
37+
~cf.ConstructList.select
38+
~cf.ConstructList.select_by_identity
39+
~cf.ConstructList.sort

‎docs/source/class/cf.Coordinate.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.. currentmodule:: cf
2+
.. default-role:: obj
3+
4+
.. _interiorring:
5+
6+
cf.InteriorRing
7+
===============
8+
9+
----
10+
11+
.. autoclass:: cf.InteriorRing
12+
:no-members:
13+
:no-inherited-members:
14+
15+
Methods
16+
-------
17+
18+
.. rubric:: Methods
19+
20+
.. autosummary::
21+
:nosignatures:
22+
:toctree: ../method/
23+
:template: method.rst
24+
25+
~cf.Coordinate.T
26+
~cf.Coordinate.X
27+
~cf.Coordinate.Y
28+
~cf.Coordinate.Z
29+
~cf.Coordinate.autoperiod
30+
~cf.Coordinate.axis
31+
~cf.Coordinate.ctype
32+
~cf.Coordinate.identities
33+
~cf.Coordinate.identity
34+
~cf.Coordinate.positive

0 commit comments

Comments
 (0)