Renaming the default_* fields to ship_* fields (#125)

* Renaming the default_* fields to ship_* fields

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Changing more function names to ship_*

* Renaming input files in test-directory

* remove sphinx-autodoc-typehints dep

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Vecko <36369090+VeckoTheGecko@users.noreply.github.com>

Author: 3 people

docs/conf.py

@@ -14,7 +14,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.mathjax",
     "sphinx.ext.napoleon",
-    "sphinx_autodoc_typehints",
+    # "sphinx_autodoc_typehints",# https://github.com/OceanParcels/virtualship/pull/125#issuecomment-2668766302
     "sphinx_copybutton",
 ]
 

docs/user-guide/tutorials/Drifter_data_tutorial.ipynb

@@ -62,7 +62,7 @@
    "outputs": [],
    "source": [
     "expedition_directory = Path(\"/Users/erik/Desktop/VSC_AgulhasDrifters\")\n",
-    "fieldset = InputData._load_default_fieldset(expedition_directory)"
+    "fieldset = InputData._load_ship_fieldset(expedition_directory)"
    ]
   },
   {

environment.yml

@@ -31,6 +31,6 @@ dependencies:
   - ipykernel
   - pandoc
   - sphinx-copybutton
-  - sphinx-autodoc-typehints
+  # - sphinx-autodoc-typehints # https://github.com/OceanParcels/virtualship/pull/125#issuecomment-2668766302
   - pydata-sphinx-theme
   - sphinx-autobuild

src/virtualship/cli/commands.py

@@ -155,17 +155,17 @@ def fetch(path: str | Path, username: str | None, password: str | None) -> None:
             "UVdata": {
                 "dataset_id": "cmems_mod_glo_phy-cur_anfc_0.083deg_PT6H-i",
                 "variables": ["uo", "vo"],
-                "output_filename": "default_uv.nc",
+                "output_filename": "ship_uv.nc",
             },
             "Sdata": {
                 "dataset_id": "cmems_mod_glo_phy-so_anfc_0.083deg_PT6H-i",
                 "variables": ["so"],
-                "output_filename": "default_s.nc",
+                "output_filename": "ship_s.nc",
             },
             "Tdata": {
                 "dataset_id": "cmems_mod_glo_phy-thetao_anfc_0.083deg_PT6H-i",
                 "variables": ["thetao"],
-                "output_filename": "default_t.nc",
+                "output_filename": "ship_t.nc",
             },
         }
 

src/virtualship/expedition/input_data.py

@@ -52,21 +52,21 @@ def load(
         else:
             argo_float_fieldset = None
         if load_adcp or load_ctd or load_ship_underwater_st or load_xbt:
-            default_fieldset = cls._load_default_fieldset(directory)
+            ship_fieldset = cls._load_ship_fieldset(directory)
         if load_adcp:
-            adcp_fieldset = default_fieldset
+            adcp_fieldset = ship_fieldset
         else:
             adcp_fieldset = None
         if load_ctd:
-            ctd_fieldset = default_fieldset
+            ctd_fieldset = ship_fieldset
         else:
             ctd_fieldset = None
         if load_ship_underwater_st:
-            ship_underwater_st_fieldset = default_fieldset
+            ship_underwater_st_fieldset = ship_fieldset
         else:
             ship_underwater_st_fieldset = None
         if load_xbt:
-            xbt_fieldset = default_fieldset
+            xbt_fieldset = ship_fieldset
         else:
             xbt_fieldset = None
 
@@ -80,12 +80,12 @@ def load(
         )
 
     @classmethod
-    def _load_default_fieldset(cls, directory: Path) -> FieldSet:
+    def _load_ship_fieldset(cls, directory: Path) -> FieldSet:
         filenames = {
-            "U": directory.joinpath("default_uv.nc"),
-            "V": directory.joinpath("default_uv.nc"),
-            "S": directory.joinpath("default_s.nc"),
-            "T": directory.joinpath("default_t.nc"),
+            "U": directory.joinpath("ship_uv.nc"),
+            "V": directory.joinpath("ship_uv.nc"),
+            "S": directory.joinpath("ship_s.nc"),
+            "T": directory.joinpath("ship_t.nc"),
         }
         variables = {"U": "uo", "V": "vo", "S": "so", "T": "thetao"}
         dimensions = {

tests/expedition/expedition_dir/input_data/.gitignore

@@ -2,8 +2,8 @@
 !argo_float_t.nc
 !argo_float_uv.nc
 !bathymetry.nc
-!default_s.nc
-!default_t.nc
-!default_uv.nc
+!ship_s.nc
+!ship_t.nc
+!ship_uv.nc
 !drifter_t.nc
 !drifter_uv.nc