Updates for changes to opendrift and more

README.md

@@ -16,6 +16,20 @@ Manager for particle tracking simulations.
 <p><small>Project based on the <a target="_blank" href="https://github.com/jbusecke/cookiecutter-science-project">cookiecutter science project template</a>.</small></p>
 
 
+# Installation
+
+Install with
+
+    pip install particle-tracking-manager
+
+or
+
+    conda install -c conda-forge particle-tracking-manager
+
+To install environment from github repo after cloning repo:
+
+    conda env create -f environment.yml
+
 To install packages to run pre-commit:
 
     mamba install --file requirements-dev.txt

environment.yml

@@ -7,6 +7,7 @@ dependencies:
   # Examples (remove and add as needed)
   - adios_db
   - aiohttp
+  - fastparquet
   - jupyter
   - jupyterlab
   - xarray

particle_tracking_manager/cli.py

@@ -47,6 +47,17 @@ def is_datestr(s):
         return False
 
 
+def is_deltastr(s):
+    """Check if string is actually a Timedelta."""
+
+    try:
+        out = pd.Timedelta(s)
+        assert not pd.isnull(out)
+        return True
+    except (ValueError, AssertionError):
+        return False
+
+
 # https://sumit-ghosh.com/articles/parsing-dictionary-key-value-pairs-kwargs-argparse-python/
 class ParseKwargs(argparse.Action):
     """With can user can input dicts on CLI."""
@@ -70,6 +81,8 @@ def __call__(self, parser, namespace, values, option_string=None):
                 value = None
             elif is_datestr(value):
                 value = pd.Timestamp(value)
+            elif is_deltastr(value):
+                value = pd.Timedelta(value)
             getattr(namespace, self.dest)[key] = value
 
 

particle_tracking_manager/the_manager_config.json

@@ -124,6 +124,12 @@
         "ptm_level": 1,
         "description": "Name of ocean model to use for driving drifter simulation, by default None. Use None for testing and set up. Otherwise input a string. Options are \"NWGOA\", \"CIOFS\", \"CIOFS_now\". Alternatively keep as None and set up a separate reader (see example in docs)."
     },
+    "ocean_model_local": {
+        "type": "bool",
+        "default": false,
+        "ptm_level": 3,
+        "description": "Set to True to use local version of known `ocean_model` instead of remote version."
+    },
     "surface_only": {
         "type": "bool",
         "default": "None",