disdrodb 0.0.20__py3-none-any.whl → 0.1.0__py3-none-any.whl

disdrodb/cli/disdrodb_download_station.py

@@ -0,0 +1,84 @@
+#!/usr/bin/env python3
+
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""Routine to download station data from the DISDRODB Decentralized Data Archive."""
+
+import sys
+from typing import Optional
+
+import click
+
+from disdrodb.data_transfer.download_data import click_download_options
+from disdrodb.utils.cli import (
+    click_data_archive_dir_option,
+    click_metadata_archive_dir_option,
+    click_station_arguments,
+    parse_archive_dir,
+)
+
+sys.tracebacklimit = 0  # avoid full traceback error if occur
+
+
+@click.command()
+@click_station_arguments
+@click_data_archive_dir_option
+@click_metadata_archive_dir_option
+@click_download_options
+def disdrodb_download_station(
+    data_source: str,
+    campaign_name: str,
+    station_name: str,
+    data_archive_dir: Optional[str] = None,
+    metadata_archive_dir: Optional[str] = None,
+    force: bool = False,
+):
+    """
+    Download data of a single DISDRODB station from the DISDRODB remote repository.
+
+    Parameters
+    ----------
+    data_source : str
+        The name of the institution (for campaigns spanning multiple countries) or
+        the name of the country (for campaigns or sensor networks within a single country).
+        Must be provided in UPPER CASE.
+    campaign_name : str
+        The name of the campaign. Must be provided in UPPER CASE.
+    station_name : str
+        The name of the station.
+    data_archive_dir : str, optional
+        The base directory of DISDRODB, expected in the format ``<...>/DISDRODB``.
+        If not specified, the path specified in the DISDRODB active configuration will be used.
+    force: bool, optional
+        If ``True``, overwrite the already existing raw data file.
+        The default value is ``False``.
+    data_archive_dir : str (optional)
+        DISDRODB Data Archive directory. Format: ``<...>/DISDRODB``.
+        If ``None`` (the default), the disdrodb config variable ``data_archive_dir`` is used.
+    """
+    from disdrodb.data_transfer.download_data import download_station
+
+    data_archive_dir = parse_archive_dir(data_archive_dir)
+    metadata_archive_dir = parse_archive_dir(metadata_archive_dir)
+    download_station(
+        data_archive_dir=data_archive_dir,
+        metadata_archive_dir=metadata_archive_dir,
+        data_source=data_source,
+        campaign_name=campaign_name,
+        station_name=station_name,
+        force=force,
+    )

disdrodb/{api/scripts → cli}/disdrodb_initialize_station.py

@@ -14,11 +14,18 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
+"""Script to initialize the DISDRODB station directory structure."""
 import sys
+from typing import Optional
 
 import click
 
-from disdrodb.utils.scripts import click_base_dir_option, click_station_arguments, parse_base_dir
+from disdrodb.utils.cli import (
+    click_data_archive_dir_option,
+    click_metadata_archive_dir_option,
+    click_station_arguments,
+    parse_archive_dir,
+)
 
 sys.tracebacklimit = 0  # avoid full traceback error if occur
 
@@ -28,16 +35,18 @@ sys.tracebacklimit = 0  # avoid full traceback error if occur
 
 @click.command()
 @click_station_arguments
-@click_base_dir_option
+@click_data_archive_dir_option
+@click_metadata_archive_dir_option
 def disdrodb_initialize_station(
     # Station arguments
     data_source: str,
     campaign_name: str,
     station_name: str,
-    # Processing options
-    base_dir: str = None,
+    # DISDRODB root directories
+    data_archive_dir: Optional[str] = None,
+    metadata_archive_dir: Optional[str] = None,
 ):
-    """Initialize the DISDRODB directory structure for a station.
+    r"""Initialize the DISDRODB directory structure for a station.
 
     It adds the relevant directories and the default issue and metadata YAML files..
 
@@ -51,19 +60,22 @@ def disdrodb_initialize_station(
         Campaign name. Must be UPPER CASE.\n
     station_name : str \n
         Station name \n
-    base_dir : str \n
-        Base directory of DISDRODB \n
+    data_archive_dir : str \n
+        DISDRODB Data Archive directory \n
         Format: <...>/DISDRODB \n
         If not specified, uses path specified in the DISDRODB active configuration. \n
     """
     from disdrodb.api.create_directories import create_initial_station_structure
 
-    base_dir = parse_base_dir(base_dir)
+    data_archive_dir = parse_archive_dir(data_archive_dir)
+    metadata_archive_dir = parse_archive_dir(metadata_archive_dir)
 
     create_initial_station_structure(
-        base_dir=base_dir,
+        # DISDRODB root directories
+        data_archive_dir=data_archive_dir,
+        metadata_archive_dir=metadata_archive_dir,
+        # Station arguments
         data_source=data_source,
         campaign_name=campaign_name,
         station_name=station_name,
     )
-    return None

disdrodb/cli/disdrodb_metadata_archive_directory.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""Routine to print the DISDRODB Data Archive directory."""
+import sys
+
+import click
+
+sys.tracebacklimit = 0  # avoid full traceback error if occur
+
+
+@click.command()
+def disdrodb_metadata_archive_directory():
+    """Print the DISDRODB Metadata Archive directory."""
+    import disdrodb
+
+    print("The DISDRODB Metadata Archive Directory is: ", disdrodb.get_metadata_archive_dir(None))

disdrodb/{data_transfer/scripts/disdrodb_download_station.py → cli/disdrodb_open_data_archive.py}

@@ -16,36 +16,36 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
-"""Routines to download station data from the DISDRODB Decentralized Data Archive."""
+"""Routine to open the DISDRODB Data Archive."""
 
 import sys
+from typing import Optional
 
 import click
 
-from disdrodb.data_transfer.download_data import click_download_options
-from disdrodb.utils.scripts import click_base_dir_option, click_station_arguments, parse_base_dir
+from disdrodb.utils.cli import (
+    click_data_archive_dir_option,
+    parse_archive_dir,
+)
 
 sys.tracebacklimit = 0  # avoid full traceback error if occur
 
 
 @click.command()
-@click_station_arguments
-@click_base_dir_option
-@click_download_options
-def disdrodb_download_station(
-    data_source: str,
-    campaign_name: str,
-    station_name: str,
-    base_dir: str = None,
-    force: bool = False,
+@click_data_archive_dir_option
+def disdrodb_open_data_archive(
+    data_archive_dir: Optional[str] = None,
 ):
-    from disdrodb.data_transfer.download_data import download_station
-
-    base_dir = parse_base_dir(base_dir)
-    download_station(
-        base_dir=base_dir,
-        data_source=data_source,
-        campaign_name=campaign_name,
-        station_name=station_name,
-        force=force,
-    )
+    """Open the DISDRODB Data Archive.
+
+    Parameters
+    ----------
+    data_archive_dir : str, optional
+        The base directory of DISDRODB, expected in the format ``<...>/DISDRODB``.
+        If not specified, the path specified in the DISDRODB active configuration will be used.
+    """
+    from disdrodb.api.io import open_data_archive
+
+    data_archive_dir = parse_archive_dir(data_archive_dir)
+
+    open_data_archive(data_archive_dir=data_archive_dir)

disdrodb/cli/disdrodb_open_logs_directory.py

@@ -0,0 +1,69 @@
+#!/usr/bin/env python3
+
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""Routine to open the DISDRODB Data Archive logs directory."""
+
+import sys
+from typing import Optional
+
+import click
+
+from disdrodb.utils.cli import (
+    click_data_archive_dir_option,
+    click_station_arguments,
+    parse_archive_dir,
+)
+
+sys.tracebacklimit = 0  # avoid full traceback error if occur
+
+
+@click.command()
+@click_station_arguments
+@click_data_archive_dir_option
+def disdrodb_open_logs_directory(
+    data_source: str,
+    campaign_name: str,
+    station_name: Optional[str] = None,
+    data_archive_dir: Optional[str] = None,
+):
+    """Open the DISDRODB Data Archive logs directory of a station.
+
+    Parameters
+    ----------
+    data_source : str
+        The name of the institution (for campaigns spanning multiple countries) or
+        the name of the country (for campaigns or sensor networks within a single country).
+        Must be provided in UPPER CASE.
+    campaign_name : str
+        The name of the campaign. Must be provided in UPPER CASE.
+    station_name : str
+        The name of the station.
+    data_archive_dir : str, optional
+        The base directory of DISDRODB, expected in the format ``<...>/DISDRODB``.
+        If not specified, the path specified in the DISDRODB active configuration will be used.
+    """
+    from disdrodb.api.io import open_logs_directory
+
+    data_archive_dir = parse_archive_dir(data_archive_dir)
+
+    open_logs_directory(
+        data_archive_dir=data_archive_dir,
+        data_source=data_source,
+        campaign_name=campaign_name,
+        station_name=station_name,
+    )

disdrodb/{data_transfer/scripts/disdrodb_upload_station.py → cli/disdrodb_open_metadata_archive.py}

@@ -16,38 +16,36 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------.
-"""Routines to upload station data to the DISDRODB Decentralized Data Archive."""
+"""Routine to open the DISDRODB Metadata Data Archive."""
 
 import sys
+from typing import Optional
 
 import click
 
-from disdrodb.data_transfer.upload_data import click_upload_options
-from disdrodb.utils.scripts import click_base_dir_option, click_station_arguments, parse_base_dir
+from disdrodb.utils.cli import (
+    click_metadata_archive_dir_option,
+    parse_archive_dir,
+)
 
 sys.tracebacklimit = 0  # avoid full traceback error if occur
 
 
 @click.command()
-@click_station_arguments
-@click_upload_options
-@click_base_dir_option
-def disdrodb_upload_station(
-    data_source: str,
-    campaign_name: str,
-    station_name: str,
-    platform: str = None,
-    base_dir: str = None,
-    force: bool = False,
+@click_metadata_archive_dir_option
+def disdrodb_open_metadata_archive(
+    metadata_archive_dir: Optional[str] = None,
 ):
-    from disdrodb.data_transfer.upload_data import upload_station
-
-    base_dir = parse_base_dir(base_dir)
-    upload_station(
-        base_dir=base_dir,
-        data_source=data_source,
-        campaign_name=campaign_name,
-        station_name=station_name,
-        platform=platform,
-        force=force,
-    )
+    """Open the DISDRODB Metadata Archive.
+
+    Parameters
+    ----------
+    metadata_archive_dir : str, optional
+        The base directory of DISDRODB, expected in the format ``<...>/DISDRODB``.
+        If not specified, the path specified in the DISDRODB active configuration will be used.
+    """
+    from disdrodb.api.io import open_metadata_archive
+
+    metadata_archive_dir = parse_archive_dir(metadata_archive_dir)
+
+    open_metadata_archive(metadata_archive_dir=metadata_archive_dir)

disdrodb/cli/disdrodb_open_metadata_directory.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""Routine to open the DISDRODB Data Archive logs directory."""
+
+import sys
+from typing import Optional
+
+import click
+
+from disdrodb.utils.cli import (
+    click_metadata_archive_dir_option,
+    click_station_arguments,
+    parse_archive_dir,
+)
+
+sys.tracebacklimit = 0  # avoid full traceback error if occur
+
+
+@click.command()
+@click_station_arguments
+@click_metadata_archive_dir_option
+def disdrodb_open_metadata_directory(
+    data_source: str,
+    campaign_name: str,
+    station_name: Optional[str] = None,
+    metadata_archive_dir: Optional[str] = None,
+):
+    """Open the DISDRODB Data Archive logs directory of a station.
+
+    Parameters
+    ----------
+    data_source : str
+        The name of the institution (for campaigns spanning multiple countries) or
+        the name of the country (for campaigns or sensor networks within a single country).
+        Must be provided in UPPER CASE.
+    campaign_name : str
+        The name of the campaign. Must be provided in UPPER CASE.
+    station_name : str
+        The name of the station.
+    metadata_archive_dir : str, optional
+        The directory path where the DISDRODB Metadata Archive is located.
+        The directory path must end with ``<...>/DISDRODB``.
+        If ``None``, it uses the ``metadata_archive_dir`` path specified
+        in the DISDRODB active configuration.
+    """
+    from disdrodb.api.io import open_metadata_directory
+
+    metadata_archive_dir = parse_archive_dir(metadata_archive_dir)
+
+    open_metadata_directory(
+        metadata_archive_dir=metadata_archive_dir,
+        data_source=data_source,
+        campaign_name=campaign_name,
+        station_name=station_name,
+    )

disdrodb/cli/disdrodb_open_product_directory.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""Routine to open the DISDRODB Data Archive station product directory."""
+
+import sys
+from typing import Optional
+
+import click
+
+from disdrodb.utils.cli import (
+    click_data_archive_dir_option,
+    click_station_arguments,
+    parse_archive_dir,
+)
+
+sys.tracebacklimit = 0  # avoid full traceback error if occur
+
+
+@click.command()
+@click.argument("product", metavar="<product>")
+@click_station_arguments
+@click_data_archive_dir_option
+def disdrodb_open_product_directory(
+    product: str,
+    data_source: str,
+    campaign_name: str,
+    station_name: str,
+    data_archive_dir: Optional[str] = None,
+):
+    """Open the DISDRODB Data Archive logs directory of a station.
+
+    Parameters
+    ----------
+    product : str
+        DISDRODB product.
+    data_source : str
+        The name of the institution (for campaigns spanning multiple countries) or
+        the name of the country (for campaigns or sensor networks within a single country).
+        Must be provided in UPPER CASE.
+    campaign_name : str
+        The name of the campaign. Must be provided in UPPER CASE.
+    station_name : str
+        The name of the station.
+    data_archive_dir : str, optional
+        The base directory of DISDRODB, expected in the format ``<...>/DISDRODB``.
+        If not specified, the path specified in the DISDRODB active configuration will be used.
+    """
+    from disdrodb.api.io import open_product_directory
+
+    data_archive_dir = parse_archive_dir(data_archive_dir)
+
+    open_product_directory(
+        data_archive_dir=data_archive_dir,
+        product=product,
+        data_source=data_source,
+        campaign_name=campaign_name,
+        station_name=station_name,
+    )

disdrodb/cli/disdrodb_open_readers_directory.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+
+# -----------------------------------------------------------------------------.
+# Copyright (c) 2021-2023 DISDRODB developers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# -----------------------------------------------------------------------------.
+"""Routine to open the disdrodb software readers directory."""
+import sys
+
+import click
+
+sys.tracebacklimit = 0  # avoid full traceback error if occur
+
+
+@click.command()
+def disdrodb_open_readers_directory():
+    """Open the disdrodb software readers directory."""
+    from disdrodb.api.io import open_readers_directory
+
+    open_readers_directory()