Skip to content

Commit

Permalink
notebook -> guide
Browse files Browse the repository at this point in the history
  • Loading branch information
dafyddstephenson committed Nov 14, 2024
1 parent fb845f4 commit 18fa47d
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/2_importing_and_running_a_case_from_a_blueprint.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@
"\n",
"1. The `location` attribute can either be a **local path** or a **URL**. If it is set to a URL, the `file_hash` (a 256 bit checksum) must also be provided to verify the download.\n",
" \n",
"2. The file described by location can be either **netCDF** or **yaml** format. When C-Star sees a yaml file instead of a netCDF file for ROMS input data, it assumes the file contains a set of instructions to be passed to the [`roms-tools` package](https://roms-tools.readthedocs.io/en/latest/), which will then generate the netCDF file for us when `InputDataset.get()` is called. This makes it easier to share and save ROMS configurations without the overhead associated with potentially large netCDF files. More information on using `roms-tools` with C-Star can be found in [this notebook](https://c-star.readthedocs.io/en/latest/4_preparing_roms_input_datasets.html)\n",
"2. The file described by location can be either **netCDF** or **yaml** format. When C-Star sees a yaml file instead of a netCDF file for ROMS input data, it assumes the file contains a set of instructions to be passed to the [`roms-tools` package](https://roms-tools.readthedocs.io/en/latest/), which will then generate the netCDF file for us when `InputDataset.get()` is called. This makes it easier to share and save ROMS configurations without the overhead associated with potentially large netCDF files. More information on using `roms-tools` with C-Star can be found on [this page](https://c-star.readthedocs.io/en/latest/4_preparing_roms_input_datasets.html)\n",
"\n",
"</div>"
]
Expand Down
2 changes: 1 addition & 1 deletion docs/3_restarting_and_continuing_a_case.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"metadata": {},
"source": [
"# Restarting & continuing a `Case`\n",
"In this notebook we will:\n",
"In this guide we will:\n",
"\n",
"- Take the Case we ran for two days (2012-01-01 to 2012-01-03) on the [previous page](https://c-star.readthedocs.io/en/latest/2_importing_and_running_a_case_from_a_blueprint.html) and create a new Case that picks up where it ends (`Case.restart()`)\n",
"- Run this second case with a larger time step for the remainder of the month of January 2012\n",
Expand Down
4 changes: 2 additions & 2 deletions docs/4_preparing_roms_input_datasets.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"\n",
"If we want to build a `C-Star` blueprint from scratch, we first have to make the input data for our new ROMS simulation. The path to the input data files will then go into the C-Star blueprint.\n",
"\n",
"In this notebook, we prepare all the input data necessary for a ROMS simulation. This includes the \n",
"In this guide, we prepare all the input data necessary for a ROMS simulation. This includes the \n",
"\n",
"* grid\n",
"* initial conditions\n",
Expand Down Expand Up @@ -14097,7 +14097,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "cstar_env_hpc",
"display_name": "cstar_env",
"language": "python",
"name": "cstar_env"
},
Expand Down

0 comments on commit 18fa47d

Please sign in to comment.