Skip to content

Update of documentation for #4223 #4241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jmorris-uk wants to merge 2 commits into
base: main
Choose a base branch
from
+20 −14
Open

Update of documentation for #4223 #4241

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebf56c8
Update of documentation for #4223
jmorris-uk May 12, 2026
378ed99
Changes after review of #4223
jmorris-uk May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions documentation/source/io/input-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
28 changes: 17 additions & 11 deletions documentation/source/usage/running-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,7 @@ 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`.
Copy link
Copy Markdown
Collaborator

@clmould clmould May 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These sentences aren't needed any more

Copy link
Copy Markdown
Contributor Author

@jmorris-uk jmorris-uk May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why these aren't needed? It explains they need to end in IN.DAT and if you run with no input file it prints the help message.

Copy link
Copy Markdown
Collaborator

@clmould clmould May 19, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry worded this badly as I gave no explanation! The bit about ending in IN.DAT is already below (on line 21), and then the bit about process giving the help menu can be moved down to join the bit already on line 70, so all this information will stay here, just rearranged a tad. I think referencing 'running without an input file' isn't as clear as instead saying running process will give the help message


The user can provide a named input file, provided the last 6 characters of the input file name are IN.DAT.
```bash
Expand All @@ -29,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.
Expand All @@ -41,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
Expand All @@ -73,6 +73,12 @@ The full set of command line arguments is available with:
process --help
```

or

```bash
process
```

------------

## Configuration file for VaryRun
Expand Down
1 change: 1 addition & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading