Skip to content

Commit

Permalink
Pass pre-commit tests
Browse files Browse the repository at this point in the history
cleaned up a couple files that were triggering pre-commit fails
  • Loading branch information
mnlevy1981 committed Oct 14, 2024
1 parent 8f1653b commit 43814b9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion examples/nblibrary/atm/link_to_ADF.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
},
"outputs": [],
"source": [
"html_link='../'"
"html_link = \"../\""
]
},
{
Expand Down
22 changes: 11 additions & 11 deletions helper_scripts/generate_cupid_config_for_cesm_case.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ def _parse_args():

def generate_cupid_config(case_root, cesm_root, cupid_example):
"""
Generate a CUPiD `config.yml` file based on information from a CESM case and
Generate a CUPiD `config.yml` file based on information from a CESM case and
a specific CUPiD example configuration (such as 'key metrics').
This function takes the root directory of the CESM case and the CESM installation,
along with the name of a CUPiD example. It validates the example, loads information
from the CESM case (such as the case name and output directory), modifies the
configuration based on the case-specific data, and generates a new `config.yml` file
This function takes the root directory of the CESM case and the CESM installation,
along with the name of a CUPiD example. It validates the example, loads information
from the CESM case (such as the case name and output directory), modifies the
configuration based on the case-specific data, and generates a new `config.yml` file
in the current working directory.
The generated `config.yml` file contains:
Expand All @@ -66,23 +66,23 @@ def generate_cupid_config(case_root, cesm_root, cupid_example):
----------
case_root : str
The root directory of the CESM case from which case-specific data will be retrieved.
cesm_root : str
The root directory of the CESM installation, where CIME scripts and CUPiD examples reside.
cupid_example : str
The name of a CUPiD example (e.g., 'key metrics') to base the configuration file on.
The name of a CUPiD example (e.g., 'key metrics') to base the configuration file on.
Must be a valid subdirectory within the CUPiD examples directory.
Raises:
-------
KeyError:
If the provided CUPiD example is not found in the valid CUPiD examples directory.
Outputs:
--------
config.yml : file
A YAML file containing the generated configuration based on the provided CESM case
A YAML file containing the generated configuration based on the provided CESM case
and CUPiD example.
"""

Expand Down

0 comments on commit 43814b9

Please sign in to comment.