From 2a50f875a5bd1a1dc49bcfcbcf0d116a6193e07f Mon Sep 17 00:00:00 2001 From: Carlos Rueda Date: Mon, 26 Aug 2024 11:12:48 -0700 Subject: [PATCH] rename pbp-plot to pbp-hmb-plot --- CHANGELOG.md | 1 + README.md | 12 ++++++------ justfile | 8 ++++---- misc/plot.sh | 2 +- pbp/{plot.py => main_plot.py} | 0 pyproject.toml | 2 +- 6 files changed, 13 insertions(+), 12 deletions(-) rename pbp/{plot.py => main_plot.py} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index c164bfe..1fdcaf1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - 1.4.2: - renamed `pbp` CLI program to `pbp-hmb-gen` + - renamed `pbp-plot` CLI program to `pbp-hmb-plot` - 1.4.1 - HMB generation CLI now with `--s3-unsigned` option to use unsigned config. diff --git a/README.md b/README.md index eb3bb41..3babba3 100644 --- a/README.md +++ b/README.md @@ -50,12 +50,12 @@ and also provides APIs you can use in your Python scripts or notebooks. The package includes the following CLI programs: -| Program | Description | -| ------- |------------------------------------------------| -| [`pbp-meta-gen`](https://docs.mbari.org/pbp/pbp-meta-gen/) | Generate JSON files with audio metadata. | -| [`pbp`](https://docs.mbari.org/pbp/pbp/) | Main HMB generation program. | -| [`pbp-cloud`](https://docs.mbari.org/pbp/pbp-cloud/) | Program for cloud based processing. | -| [`pbp-plot`](https://docs.mbari.org/pbp/pbp-plot/) | Utility program to plot resulting HMB product. | +| Program | Description | +|------------------------------------------------------------|-----------------------------------------| +| [`pbp-meta-gen`](https://docs.mbari.org/pbp/pbp-meta-gen/) | Generate JSON files with audio metadata | +| [`pbp-hmb-gen`](https://docs.mbari.org/pbp/pbp-hmb-gen/) | Main HMB generation program | +| [`pbp-cloud`](https://docs.mbari.org/pbp/pbp-cloud/) | Program for cloud based processing | +| [`pbp-hmb-plot`](https://docs.mbari.org/pbp/pbp-hmb-plot/) | Utility program to plot HMB product | ### API diff --git a/justfile b/justfile index f44e9c4..a8de134 100644 --- a/justfile +++ b/justfile @@ -159,8 +159,8 @@ main-nrs11-multiple-days year month *days="": wait # Plot NRS11 datasets -plot-nrs11 *netcdfs='NRS11/OUTPUT/NRS11_20200101.nc': - poetry run python pbp/plot.py \ +hmb-plot-nrs11 *netcdfs='NRS11/OUTPUT/NRS11_20200101.nc': + poetry run python pbp/main_plot.py \ --ylim 10 2000 \ --cmlim 64 108 \ --latlon 37.88 -123.44 \ @@ -237,8 +237,8 @@ main *args="": # misc/utils: # Generate summary plots -plot *args: - poetry run python pbp/plot.py {{args}} +hmb-plot *args: + poetry run python pbp/main_plot.py {{args}} ############## # docker: diff --git a/misc/plot.sh b/misc/plot.sh index 08bd93f..e22d3d1 100644 --- a/misc/plot.sh +++ b/misc/plot.sh @@ -8,7 +8,7 @@ dir=$1 for nc in "${dir}"/*nc; do echo -e "\n=== ${nc} ===" - python src/plot.py \ + python src/main_plot.py \ --latlon 35.77 -121.43 \ --ylim 10 24000 \ --title 'Location: MB05, Monterey Bay National Marine Sanctuary, 35.77°N 121.43°W' \ diff --git a/pbp/plot.py b/pbp/main_plot.py similarity index 100% rename from pbp/plot.py rename to pbp/main_plot.py diff --git a/pyproject.toml b/pyproject.toml index 3532d6a..9d1df48 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,7 +19,7 @@ packages = [{include = "pbp"}] [tool.poetry.scripts] pbp-hmb-gen = "pbp.main_hmb_generator:main" pbp-cloud = "pbp.main_cloud:main" -pbp-plot = "pbp.plot:main" +pbp-hmb-plot = "pbp.main_plot:main" pbp-meta-gen = "pbp.main_meta_generator:main" [tool.poetry.dependencies]