Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove the default gcpy/benchmark/modules/species_database.yml file #339

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

yantosca
Copy link
Contributor

Name and Institution (Required)

Name: Bob Yantosca
Institution: Harvard + GCST

Describe the update

This is the companion PR to #333. We have removed the gcpy/benchmark/modules/species_database.yml file, which formerly was used by the benchmarking code in case the species_database.yml file was not found in the Dev run directory. This file by now is seriously out of date w/r/t the species_database.yml in GEOS-Chem, so it is better not to rely on it.

The benchmarking scripts now allow you to specify a path to the species database file in the YAML config files (e.g. 1mo_benchmark.yml, 1yr_fullchem_benchmark.yml, etc). So relying on a default species_database.yml file is no longer necessary.

In several benchmarking routines (in gcpy/benchmark/modules/), the spcdb_dir (path to the folder containing species_database.yml) argument is now set to None by default. Error checks then will raise a ValueError if the spcdb_dir is None and not str. This will gracefully terminate program execution.

Expected changes

This is a zero-diff update.

Reference(s)

If this is a science update, please provide a literature citation.

Related Github Issue

gcpy/benchmark/modules/species_database.yml
- Removed.  This file was substantially out-of-date with GEOS-Chem.
  We now specify the path to this file in the YAML configuration files
  that are passed to gcpy/benchmark/run_benchmark.py, so this is now
  redundant.

gcpy/benchmark/modules/benchmark_drydep.py
gcpy/benchmark/modules/benchmark_funcs.py
gcpy/benchmark/modules/benchmark_mass_cons_table.py
gcpy/benchmark/modules/budget_ox.py
gcpy/benchmark/modules/budget_tt.py
gcpy/benchmark/modules/oh_metrics.py
- Replaced spcdb_dir=os.path.dirname(__file__) with spcdb_dir=None
  in function interfaces
- Add code to throw a ValueError if spcdb_dir is None

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <[email protected]>
@yantosca yantosca added category: Feature Request New feature or request topic: Benchmark Plots and Tables Issues pertaining to generating plots/tables from benchmark output labels Sep 12, 2024
@yantosca yantosca added this to the 1.6.0 milestone Sep 12, 2024
@yantosca yantosca self-assigned this Sep 12, 2024
@yantosca yantosca changed the title Remove tje default gcpy/benchmark/modules/species_database.yml file Remove the default gcpy/benchmark/modules/species_database.yml file Sep 12, 2024
Copy link
Contributor

@msulprizio msulprizio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to merge

@yantosca yantosca merged commit cfe6b55 into dev Sep 12, 2024
14 checks passed
@yantosca yantosca deleted the feature/remove-species-db-file branch September 12, 2024 18:32
@yantosca yantosca linked an issue Sep 12, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: Feature Request New feature or request topic: Benchmark Plots and Tables Issues pertaining to generating plots/tables from benchmark output
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove gcpy/benchmark/modules/species_database.yml
2 participants