Merge pull request #23 from CNES/feature/metadata_improvements

Feature/metadata improvements

Author: fbriol

examples/ex_indexing.py

@@ -66,6 +66,7 @@ def split_half_orbit(
     """Calculate the indexes of the start and stop of each half-orbit.
 
     Args:
+        cycle_number: Cycle numbers.
         pass_number: Pass numbers.
     Returns:
         Iterator of start and stop indexes.
@@ -95,7 +96,7 @@ def _half_orbit(
     """Return the indexes of the start and stop of each half-orbit.
 
     Args:
-        ds: Datasets stored in a partition to be indexed.
+        zds: Datasets stored in a partition to be indexed.
     Returns:
         Dictionary of start and stop indexes for each half-orbit.
     """
@@ -149,7 +150,7 @@ def create(
 
         Args:
             path: The path to the index.
-            ds: The collection to be indexed.
+            zds: The collection to be indexed.
             filesystem: The filesystem to use.
         Returns:
             The created index.
@@ -169,7 +170,7 @@ def update(
         """Update the index.
 
         Args:
-            ds: New data stored in the collection to be indexed.
+            zds: New data stored in the collection to be indexed.
             partition_size: The length of each bag partition.
             npartitions: The number of desired bag partitions.
             cycle_number: The name of the cycle number variable stored in the

setup.cfg

@@ -37,7 +37,7 @@ install_requires =
 package_dir =
     = .
 packages = find:
-python_requires = >=3.8
+python_requires = >=3.10
 zip_safe = False
 
 [options.extras_require]

zcollection/__init__.py

@@ -19,10 +19,11 @@
     create_view,
     open_collection,
     open_view,
+    update_deprecated_collection,
 )
 from .dataset import Dataset, Expression
 from .meta import Attribute
-from .variable import Array, DelayedArray, Variable
+from .variable import Array, DelayedArray, Variable, new_variable
 from .version import __version__
 from .view import View, ViewReference, ViewUpdateCallable
 
@@ -41,12 +42,14 @@
     'merging',
     'open_collection',
     'open_view',
+    'update_deprecated_collection',
     'PartitionCallable',
     'PartitionFilter',
     'PartitionFilterCallback',
     'partitioning',
     'UpdateCallable',
     'Variable',
+    'new_variable',
     'version',
     'View',
     'ViewReference',