From ebf56c8091584ab22672f1fbcba07e693842321f Mon Sep 17 00:00:00 2001 From: jmorris-uk Date: Tue, 12 May 2026 13:19:00 +0100 Subject: [PATCH 1/2] Update of documentation for #4223 --- documentation/source/usage/running-process.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/documentation/source/usage/running-process.md b/documentation/source/usage/running-process.md index 86844903ad..6ca5c568d8 100644 --- a/documentation/source/usage/running-process.md +++ b/documentation/source/usage/running-process.md @@ -14,12 +14,9 @@ A SCAN is available in any of these modes. One input variable can be scanned (` ## To run PROCESS -The default PROCESS input file name is IN.DAT. If no input file name is given as an argument in the command line, it assumes an IN.DAT file is present in the current directory: -```bash -# Use an IN.DAT file in the current directory -process -``` -In this case the output files will be `OUT.DAT` and `MFILE.DAT`. +PROCESS input file names end in IN.DAT. If no input file name is given as an argument in the command line, PROCESS will run `process --help`. + +The `examples/data` folder in the repository has the commonly used `large_tokamak_IN.DAT` input file, which can be a useful starting point for new users. The user can provide a named input file, provided the last 6 characters of the input file name are IN.DAT. ```bash From 378ed99e15ded85f54ad89c055a2ac73dff355a2 Mon Sep 17 00:00:00 2001 From: jmorris-uk Date: Tue, 19 May 2026 13:28:47 +0100 Subject: [PATCH 2/2] Changes after review of #4223 --- documentation/source/io/input-guide.md | 5 ++-- documentation/source/usage/running-process.md | 23 +++++++++++++------ examples/README.md | 1 + 3 files changed, 19 insertions(+), 10 deletions(-) diff --git a/documentation/source/io/input-guide.md b/documentation/source/io/input-guide.md index 4176d5ba1b..a964d2a2f1 100644 --- a/documentation/source/io/input-guide.md +++ b/documentation/source/io/input-guide.md @@ -13,9 +13,8 @@ indication of where in the input file the problem lies. ## File Naming Convention -The default PROCESS input file name is `IN.DAT`. The user can provide a named -input file, that will produce named output files, provided the last 6 characters -of the input file name are `IN.DAT`. +The user can provide a named input file, that will produce named output files, +provided the last 6 characters of the input file name are `IN.DAT`. ```bash process -i [path-to-file]/my_file_name_IN.DAT diff --git a/documentation/source/usage/running-process.md b/documentation/source/usage/running-process.md index 6ca5c568d8..e329e7fb3f 100644 --- a/documentation/source/usage/running-process.md +++ b/documentation/source/usage/running-process.md @@ -16,8 +16,6 @@ A SCAN is available in any of these modes. One input variable can be scanned (` PROCESS input file names end in IN.DAT. If no input file name is given as an argument in the command line, PROCESS will run `process --help`. -The `examples/data` folder in the repository has the commonly used `large_tokamak_IN.DAT` input file, which can be a useful starting point for new users. - The user can provide a named input file, provided the last 6 characters of the input file name are IN.DAT. ```bash process -i path/to/my_file_name_IN.DAT @@ -26,6 +24,8 @@ will produce the following output files in the same directory as the input file: ``` my_file_name_OUT.DAT my_file_name_MFILE.DAT + my_file_name_SIG_TF.json + my_file_name_process.log ``` It may be convenient to automatically generate the summary plots after the `PROCESS` run has finished. @@ -38,13 +38,16 @@ process -i path/to/my_file_name_IN.DAT --full-output will produce the following output files in the same directory as the input file: ``` - my_file_name_OUT.DAT - my_file_name_MFILE.DAT - SankeyPowerFlow.pdf - my_file_name.MFILE.DATSUMMARY.pdf - my_file_name.MFILE_radial_build.pdf + large_tokamak_MFILE.DAT + large_tokamak_MFILE.DATSUMMARY.pdf + large_tokamak_OUT.DAT + large_tokamak_SIG_TF.json + large_tokamak_plotly_sankey.html + large_tokamak_process.log ``` +The `examples/data` folder in the repository has the commonly used `large_tokamak_IN.DAT` input file, which can be a useful starting point for new users. + --------------- ### VaryRun @@ -70,6 +73,12 @@ The full set of command line arguments is available with: process --help ``` +or + +```bash +process +``` + ------------ ## Configuration file for VaryRun diff --git a/examples/README.md b/examples/README.md index bd6c41a5e4..e78aec16d3 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,3 +1,4 @@ + # Process Jupyter notebook examples Examples of how to use Process are provided in the form of Jupyter notebooks. These provide a convenient way of explaining Process usage alongside runnable code cells, as well as displaying some types of output.