diff --git a/README.md b/README.md index 3c9e8aee..a1b67328 100644 --- a/README.md +++ b/README.md @@ -115,6 +115,7 @@ Executable name | What it does | Command `bgcval` | runs time series and point to point. | bgcval jobID `bgcval2_make_report` | makes the single model HTML report. | bgcval2_make_report jobID `analysis_compare` | runs comparison of multiple single jobs | analysis_compare +`batch_timeseries` | Submits single job time series analysis to slurm | batch_timeseries ### Checking out development branches @@ -319,6 +320,36 @@ then the report will appear on the [JASMIN public facing page](https://gws-acces which is public facing but password protected. +Batch times series Analysis +=========================== + +The `batch_timeseries` tool can take an `analysis_compare` input yaml file, +and instead of running the time series analysis for each job on +the interactive shell terminal in series, it uses slurm to submit +each job as an independent job. + +On jasmin, users can run up to five jobs simulataneously, +so this can singnificantly boost the speed of the analysis. + +The command to run it is: +``` +batch_timeseries - y comparison_recipe.yml +``` + +There is also an optional flag `-d` or `--dry_run` to test the batch_timeseries, +which outputs the submission command to screen but does not submit the jobs. + +Note that this task does not run the `analysis_compare` suite so it will +not generate the html report. However, the html report can be generated more quickly +with the `-s` skip the `analysis_timeseries` section +described above. + +In addition, note that this will not run the `download_from_mass` +script, so jobs added here will not be included in the automated download. +However, these jobs are added for automated download when `analysis_compare` +is used. + + Downloading data using MASS ===========================