diff --git a/docs/source/getting-started/create-first-recipe.rst b/docs/source/getting-started/create-first-recipe.rst index 5cb100ec8..74883fbc3 100644 --- a/docs/source/getting-started/create-first-recipe.rst +++ b/docs/source/getting-started/create-first-recipe.rst @@ -133,20 +133,16 @@ the method by which it is done. coordinate: time method: MEAN -Finally we plot the model data, using the -``plot.spatial_contour_plot`` operator, and then save the processed data with -the ``write.write_cube_to_nc`` operator. This finishes up our recipe. - -.. TODO: Remove filename argument. +Finally we plot the model data, using the ``plot.spatial_contour_plot`` +operator, and then save the processed data with the ``write.write_cube_to_nc`` +operator. This finishes up our recipe. .. code-block:: yaml # Plotting and writing operators - operator: plot.spatial_contour_plot - filename: CSET_OUTPUT_PATH - operator: write.write_cube_to_nc - filename: CSET_OUTPUT_PATH Complete Recipe @@ -179,10 +175,8 @@ After following this far your recipe should look like this: method: MEAN - operator: plot.spatial_contour_plot - filename: CSET_OUTPUT_PATH - operator: write.write_cube_to_nc - filename: CSET_OUTPUT_PATH Running the Recipe ------------------ @@ -196,7 +190,7 @@ Use ``cset bake`` to run your newly created recipe. .. code-block:: bash - cset bake air_temp.nc output/ single_timestep_surface_air_temperature_spatial_plot.yaml + cset bake -i air_temp.nc -o output/ -r single_timestep_surface_air_temperature_spatial_plot.yaml You can investigate the created plot and data file in the specified ``output`` directory. diff --git a/docs/source/getting-started/run-recipe.rst b/docs/source/getting-started/run-recipe.rst index 038686c78..c1c6ecc93 100644 --- a/docs/source/getting-started/run-recipe.rst +++ b/docs/source/getting-started/run-recipe.rst @@ -16,7 +16,7 @@ Try the following: .. code-block:: bash - cset cookbook + cset cookbook -o recipes This will write out a recipes folder containing recipe ``.yaml`` files to your current directory. We will use the @@ -35,7 +35,7 @@ output should be a directory, but it will be created if it does not exist. .. code-block:: bash - cset bake air_temp.nc output/ recipes/mean-air-temp-spacial-plot.yaml + cset bake -i air_temp.nc -o output/ -r recipes/mean-air-temp-spacial-plot.yaml This will run the recipe and leave its output in the specified output directory. diff --git a/docs/source/reference/terminology.rst b/docs/source/reference/glossary.rst similarity index 96% rename from docs/source/reference/terminology.rst rename to docs/source/reference/glossary.rst index 068848b6b..5c1d16678 100644 --- a/docs/source/reference/terminology.rst +++ b/docs/source/reference/glossary.rst @@ -1,5 +1,5 @@ -Terminology -=========== +Glossary +======== This page describes specific terminology and concepts used within CSET. diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 5fad4390a..e04bc5207 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -7,7 +7,7 @@ components. .. toctree:: :maxdepth: 1 - terminology + glossary cli recipe-format operators diff --git a/docs/source/usage/workflow-installation.rst b/docs/source/usage/workflow-installation.rst index 81621a004..a1ac4fbf5 100644 --- a/docs/source/usage/workflow-installation.rst +++ b/docs/source/usage/workflow-installation.rst @@ -1,14 +1,10 @@ Install and run the CSET workflow ================================= -CSET is typically run through a `cylc workflow`_. As long as cylc 8 is setup at -your site (which is beyond the scope of this guide), then this guide takes you -through installing the workflow. - -The first thing you will need to do is to download the CSET workflow. The -easiest way to do that is via the `Releases`_ page on GitHub, or you can clone -the repository. Once downloaded the tarball or zip can be unpacked to a location -of your choosing. +CSET is typically run through a `cylc workflow`_. The first thing you will need +to do is to download the CSET workflow. The easiest way to do that is via the +`Releases`_ page on GitHub, or you can clone the repository. Once downloaded the +tarball or zip can be unpacked to a location of your choosing. CSET uses **cylc 8**, so you must ensure that is the version of cylc configured for usage. For the Met Office installation this involves setting an environment @@ -21,16 +17,15 @@ variable before running cylc with the following commands: You will then need to edit the configuration to set up your job. Start by making a copy of the ``rose-suite.conf.example`` file called ``rose-suite.conf``. This -needs further amendments, which are done using `rose edit`_, a GUI tool that -makes configuration files more tractable. Within rose edit go through the -sections under "suite conf" and fill in the config. Help text can be viewed by -clicking on the name of a variable. Once you have configured CSET, you can save -and close rose edit. - -Opening a command line inside the root of the CSET folder you can run it with -the command ``cylc vip .``, which will cause cylc to submit the job to your -site's batch processing system, and run it. You can view the job's progress with -the cylc gui, accessible with the command ``cylc gui``. +needs further amendments, which are done using `rose edit`_, a GUI configuration +tool. Within rose edit go through the sections under "suite conf" and fill in +the config. Help can be viewed by clicking on the name of a variable. Once +you have configured CSET, you can save and close rose edit. + +Opening a command line inside ``the cset-workflow`` folder you can run the +workflow with the command ``cylc vip .``, which will cause cylc to submit the +job to your site's batch processing system, and run it. You can view the job's +progress with the cylc gui, accessible with the command ``cylc gui``. Once CSET has finished running you will receive an email containing a link to the output page.