Skip to content

Commit f710f80

Browse files
committed
remove example outputs
1 parent 1eb82c1 commit f710f80

File tree

1 file changed

+37
-179
lines changed

1 file changed

+37
-179
lines changed

_episodes/04-recipe.md

Lines changed: 37 additions & 179 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,12 @@ Please note the following sections:
294294
{: .challenge}
295295
296296
> ## Exemplary output
297+
>
298+
> After running the `recipe_example.yml`, you will see some log information in the terminal.
299+
> The information is based on the settings in both `recipe_example.yml` and
300+
> the `config-user.yml` files.
301+
> As an example, the log information is:
302+
>
297303
> ~~~bash
298304
> 2020-07-01 08:22:58,571 UTC [33433] INFO
299305
> ______________________________________________________________________
@@ -381,12 +387,14 @@ Please note the following sections:
381387
Each time you run the ESMValTool, it will produce a new output directory within
382388
your specified work directory with the name of the recipe and the tagged
383389
runtime. This folder should contain four folders:
390+
384391
- run
385392
- work
386393
- preproc
387394
- plots
388395
389-
> ## Inspect the output:
396+
> ## Inspect the output
397+
>
390398
> Now that you have run the esmvaltool command for the first time, please locate
391399
> your output directory. If you’re missing the preproc directory, then your
392400
> `config-user.yml` file has the value remove_preproc_dir set to true (this is
@@ -395,8 +403,10 @@ runtime. This folder should contain four folders:
395403
>
396404
{: .challenge}
397405
398-
> ## Inspect specific files:
406+
> ## Inspect specific files
407+
>
399408
> Please locate and inspect the following files:
409+
>
400410
> - Your output plot(s).
401411
> - Your main output log file.
402412
> - Your settings.yml file.
@@ -407,7 +417,8 @@ runtime. This folder should contain four folders:
407417
Exemplary output (depending on the directory paths and package versions that are
408418
available) can be found below. Note that the timestamps differ.
409419
410-
> ## Your output plot(s).
420+
> ## Your output plot(s)
421+
>
411422
> Plots for the dataset(s) are located in `./recipe_example_#_#/plots/timeseries_diag/`
412423
>
413424
> For a single dataset:
@@ -419,210 +430,57 @@ available) can be found below. Note that the timestamps differ.
419430
> ![multiple datasets](../fig/MultipleModels__thetaoga_prep_timeseries_diag_timeseries_temperature_1900_2000_timeseries_.png "multiple datasets")
420431
{: .solution}
421432
422-
> ## Your main output log file.
433+
> ## Your main output log file
434+
>
423435
> The main output file is located at `./recipe_example_#_#/run/main_log.txt/`
436+
> Let's have look at the file:
424437
>
425438
> ~~~bash
426-
> INFO [33433]
427-
> ______________________________________________________________________
428-
> _____ ____ __ ____ __ _ _____ _
429-
> | ____/ ___|| \/ \ \ / /_ _| |_ _|__ ___ | |
430-
> | _| \___ \| |\/| |\ \ / / _` | | | |/ _ \ / _ \| |
431-
> | |___ ___) | | | | \ V / (_| | | | | (_) | (_) | |
432-
> |_____|____/|_| |_| \_/ \__,_|_| |_|\___/ \___/|_|
433-
> ______________________________________________________________________
434-
>
435-
> ESMValTool - Earth System Model Evaluation Tool.
436-
>
437-
> http://www.esmvaltool.org
438-
>
439-
> CORE DEVELOPMENT TEAM AND CONTACTS:
440-
> Veronika Eyring (PI; DLR, Germany - [email protected])
441-
> Bouwe Andela (NLESC, Netherlands - [email protected])
442-
> Bjoern Broetz (DLR, Germany - [email protected])
443-
> Lee de Mora (PML, UK - [email protected])
444-
> Niels Drost (NLESC, Netherlands - [email protected])
445-
> Nikolay Koldunov (AWI, Germany - [email protected])
446-
> Axel Lauer (DLR, Germany - [email protected])
447-
> Benjamin Mueller (LMU, Germany - [email protected])
448-
> Valeriu Predoi (URead, UK - [email protected])
449-
> Mattia Righi (DLR, Germany - [email protected])
450-
> Manuel Schlund (DLR, Germany - [email protected])
451-
> Javier Vegas-Regidor (BSC, Spain - [email protected])
452-
> Klaus Zimmermann (SMHI, Sweden - [email protected])
453-
>
454-
> For further help, please read the documentation at
455-
> http://esmvaltool.readthedocs.io. Have fun!
456-
>
457-
> INFO [33433] Using config file /pf/b/b380506/work/config-DKRZ.yml
458-
> INFO [33433] Writing program log files to:
459-
> /scratch/b/b380506/recipe_example_20200701_082257/run/main_log.txt
460-
> /scratch/b/b380506/recipe_example_20200701_082257/run/main_log_debug.txt
461-
> INFO [33433] Starting the Earth System Model Evaluation Tool v2.0.0b9 at time: 2020-07-01 08:22:58 UTC
462-
> INFO [33433] ----------------------------------------------------------------------
463-
> INFO [33433] RECIPE = /pf/b/b380506/work/recipes/recipe_example.yml
464-
> INFO [33433] RUNDIR = /scratch/b/b380506/recipe_example_20200701_082257/run
465-
> INFO [33433] WORKDIR = /scratch/b/b380506/recipe_example_20200701_082257/work
466-
> INFO [33433] PREPROCDIR = /scratch/b/b380506/recipe_example_20200701_082257/preproc
467-
> INFO [33433] PLOTDIR = /scratch/b/b380506/recipe_example_20200701_082257/plots
468-
> INFO [33433] ----------------------------------------------------------------------
469-
> INFO [33433] Running tasks using at most 8 processes
470-
> INFO [33433] If your system hangs during execution, it may not have enough memory for keeping this number of tasks in memory.
471-
> INFO [33433] If you experience memory problems, try reducing 'max_parallel_tasks' in your user configuration file.
472-
> INFO [33433] Creating tasks from recipe
473-
> INFO [33433] Creating tasks for diagnostic diag_timeseries_temperature
474-
> INFO [33433] Creating preprocessor task diag_timeseries_temperature/timeseries_variable
475-
> INFO [33433] Creating preprocessor 'prep_timeseries' task for variable 'thetaoga'
476-
> INFO [33433] Using input files for variable thetaoga of dataset HadGEM2-ES:
477-
> /mnt/lustre01/work/kd0956/CMIP5/data/cmip5/output1/MOHC/HadGEM2-ES/historical/mon/ocean/Omon/r1i1p1/v20110916/thetaoga/thetaoga_Omon_HadGEM2-ES_historical_r1i1p1_185912-200512.nc
478-
> INFO [33433] PreprocessingTask diag_timeseries_temperature/timeseries_variable created. It will create the files:
479-
> /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_1859-2005.nc
480-
> INFO [33433] Creating diagnostic task diag_timeseries_temperature/timeseries_diag
481-
> INFO [33433] These tasks will be executed: diag_timeseries_temperature/timeseries_variable, diag_timeseries_temperature/timeseries_diag
482-
> INFO [39196] Starting task diag_timeseries_temperature/timeseries_variable in process [39196]
483-
> INFO [33433] Progress: 1 tasks running, 1 tasks waiting for ancestors, 0/2 done
484-
> INFO [39196] Successfully completed task diag_timeseries_temperature/timeseries_variable (priority 0) in 0:00:07.241490
485-
> INFO [33433] Progress: 0 tasks running, 1 tasks waiting for ancestors, 1/2 done
486-
> INFO [39197] Starting task diag_timeseries_temperature/timeseries_diag in process [39197]
487-
> INFO [39197] Running command ['/pf/b/b380506/miniconda3/envs/esmvaltool_pub/bin/python', '/mnt/lustre01/pf/b/b380506/work/GIT/ESMValTool/esmvaltool/diag_scripts/ocean/diagnostic_timeseries.py', '/scratch/b/b380506/recipe_example_20200701_082257/run/diag_timeseries_temperature/timeseries_diag/settings.yml']
488-
> INFO [39197] Writing output to /scratch/b/b380506/recipe_example_20200701_082257/work/diag_timeseries_temperature/timeseries_diag
489-
> INFO [39197] Writing plots to /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag
490-
> INFO [39197] Writing log to /scratch/b/b380506/recipe_example_20200701_082257/run/diag_timeseries_temperature/timeseries_diag/log.txt
491-
> INFO [39197] To re-run this diagnostic script, run:
492-
> cd /scratch/b/b380506/recipe_example_20200701_082257/run/diag_timeseries_temperature/timeseries_diag; MPLBACKEND="Agg" /pf/b/b380506/miniconda3/envs/esmvaltool_pub/bin/python /mnt/lustre01/pf/b/b380506/work/GIT/ESMValTool/esmvaltool/diag_scripts/ocean/diagnostic_timeseries.py /scratch/b/b380506/recipe_example_20200701_082257/run/diag_timeseries_temperature/timeseries_diag/settings.yml
493-
> INFO [33433] Progress: 1 tasks running, 0 tasks waiting for ancestors, 1/2 done
494-
> INFO [39197] Maximum memory used (estimate): 0.2 GB
495-
> INFO [39197] Sampled every second. It may be inaccurate if short but high spikes in memory consumption occur.
496-
> WARNING [39197] No provenance information was written to /scratch/b/b380506/recipe_example_20200701_082257/run/diag_timeseries_temperature/timeseries_diag/diagnostic_provenance.yml
497-
> INFO [39197] Successfully completed task diag_timeseries_temperature/timeseries_diag (priority 1) in 0:00:07.347165
498-
> INFO [33433] Progress: 0 tasks running, 0 tasks waiting for ancestors, 2/2 done
499-
> INFO [33433] Successfully completed all tasks.
500-
> INFO [33433] Ending the Earth System Model Evaluation Tool v2.0.0b9 at time: 2020-07-01 08:23:13 UTC
501-
> INFO [33433] Time for running the recipe was: 0:00:14.820802
502-
> INFO [33433] Maximum memory used (estimate): 0.7 GB
503-
> INFO [33433] Sampled every second. It may be inaccurate if short but high spikes in memory consumption occur.
504-
> INFO [33433] Run was successful
439+
> nano ./recipe_example_#_#/run/main_log.txt
505440
> ~~~
506441
>
507442
> Note: This is the same information as the terminal output, above, but without the time stamps.
508443
{: .solution}
509444
510-
> ## Your settings.yml file.
445+
> ## Your settings.yml file
446+
>
511447
> This file is located at `./recipe_example_#_#/run/diag_timeseries_temperature/timeseries_diag/settings.yaml`.
448+
> Let's have look at the file:
449+
>
450+
> ~~~bash
451+
> nano ./recipe_example_#_#/run/diag_timeseries_temperature/timeseries_diag/settings.yaml
452+
> ~~~
512453
>
513-
> ```YAML
514-
> auxiliary_data_dir: /mnt/lustre01/pf/b/b380506/work/auxiliary_data
515-
> input_files:
516-
> - /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/metadata.yml
517-
> log_level: info
518-
> output_file_type: png
519-
> plot_dir: /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag
520-
> profile_diagnostic: false
521-
> recipe: recipe_example.yml
522-
> run_dir: /scratch/b/b380506/recipe_example_20200701_082257/run/diag_timeseries_temperature/timeseries_diag
523-
> script: timeseries_diag
524-
> version: 2.0.0b9
525-
> work_dir: /scratch/b/b380506/recipe_example_20200701_082257/work/diag_timeseries_temperature/timeseries_diag
526-
> write_netcdf: true
527-
> write_plots: true
528-
> ```
529454
{: .solution}
530455
531456
> ## A metadata.yml file.
532457
>
533458
> This file is located at `./recipe_example_#_#/preproc/diag_timeseries_temperature/timeseries_variable/metadata.yml`.
459+
> Please note that `preproc` diretctory exist if only `remove_preproc_dir: false`
460+
> in ``config-user.yml`` file.
461+
> Let's have look at the file:
462+
>
463+
> ~~~bash
464+
> nano ./recipe_example_#_#/preproc/diag_timeseries_temperature/timeseries_variable/metadata.yml
465+
> ~~~
534466
>
535-
> ```YAML
536-
> ? /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_1900-2000.nc
537-
> : alias: HadGEM2-ES
538-
> dataset: HadGEM2-ES
539-
> diagnostic: diag_timeseries_temperature
540-
> end_year: 2000
541-
> ensemble: r1i1p1
542-
> exp: historical
543-
> filename: /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_1900-2000.nc
544-
> frequency: mon
545-
> institute:
546-
> - INPE
547-
> - MOHC
548-
> long_name: Global Average Sea Water Potential Temperature
549-
> mip: Omon
550-
> modeling_realm:
551-
> - ocean
552-
> preprocessor: prep_timeseries
553-
> project: CMIP5
554-
> recipe_dataset_index: 0
555-
> short_name: thetaoga
556-
> standard_name: sea_water_potential_temperature
557-
> start_year: 1900
558-
> units: K
559-
> variable_group: timeseries_variable
560-
> ```
561467
{: .solution}
562468
563469
> ## The diagnostic log file.
470+
>
564471
> This file is located at `./recipe_example_#_#/run/diag_timeseries_temperature/timeseries_diag/log.txt`
472+
> Let's have look at the file:
565473
>
566474
> ~~~bash
567-
> Starting diagnostic script timeseries_diag with configuration:
568-
> auxiliary_data_dir: /mnt/lustre01/pf/b/b380506/work/auxiliary_data
569-
> input_data:
570-
> ? /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_1900-2000.nc
571-
> : alias: HadGEM2-ES
572-
> dataset: HadGEM2-ES
573-
> diagnostic: diag_timeseries_temperature
574-
> end_year: 2000
575-
> ensemble: r1i1p1
576-
> exp: historical
577-
> filename: /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_1900-2000.nc
578-
> frequency: mon
579-
> institute:
580-
> - INPE
581-
> - MOHC
582-
> long_name: Global Average Sea Water Potential Temperature
583-
> mip: Omon
584-
> modeling_realm:
585-
> - ocean
586-
> preprocessor: prep_timeseries
587-
> project: CMIP5
588-
> recipe_dataset_index: 0
589-
> short_name: thetaoga
590-
> standard_name: sea_water_potential_temperature
591-
> start_year: 2000
592-
> units: K
593-
> variable_group: timeseries_variable
594-
> input_files:
595-
> - /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/metadata.yml
596-
> log_level: info
597-
> output_file_type: png
598-
> plot_dir: /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag
599-
> profile_diagnostic: false
600-
> recipe: recipe_example.yml
601-
> run_dir: /scratch/b/b380506/recipe_example_20200701_082257/run/diag_timeseries_temperature/timeseries_diag
602-
> script: timeseries_diag
603-
> version: 2.0.0b9
604-
> work_dir: /scratch/b/b380506/recipe_example_20200701_082257/work/diag_timeseries_temperature/timeseries_diag
605-
> write_netcdf: true
606-
> write_plots: true
607-
>
608-
> Creating /scratch/b/b380506/recipe_example_20200701_082257/work/diag_timeseries_temperature/timeseries_diag
609-
> Creating /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag
610-
> metadata filename: /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/metadata.yml
611-
> No handles with labels found to put in legend.
612-
> Image path will be: /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag/MultipleModels__thetaoga_prep_timeseries_diag_timeseries_temperature_1900-2000_timeseries_.png
613-
> Saving plots to /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag/MultipleModels__thetaoga_prep_timeseries_diag_timeseries_temperature_1900-2000_timeseries_.png
614-
> -----------------
615-
> model filenames: /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_1859-2005.nc
616-
> Image path will be: /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag/diag_CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_prep_timeseries_diag_timeseries_temperature_1900-2000_timeseries_0.png
617-
> Saving plots to /scratch/b/b380506/recipe_example_20200701_082257/plots/diag_timeseries_temperature/timeseries_diag/diag_CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_prep_timeseries_diag_timeseries_temperature_1900-2000_timeseries_0.png
618-
> Success
619-
> End of diagnostic script run.
475+
> nano ./recipe_example_#_#/run/diag_timeseries_temperature/timeseries_diag/log.txt
620476
> ~~~
477+
>
621478
{: .solution}
622479
623480
## Do your first edits
624481
625482
> ## Edit the recipe and run again
483+
>
626484
> So far, the example recipe has used global volume-weighted ocean temperature.
627485
> Please edit this recipe to investigate one of the following fields:
628486
>

0 commit comments

Comments
 (0)