Skip to content

Update of documentation for #4223#4241

Open
jmorris-uk wants to merge 2 commits into
mainfrom
4223-default-indat-doesnt-work
Open

Update of documentation for #4223#4241
jmorris-uk wants to merge 2 commits into
mainfrom
4223-default-indat-doesnt-work

Conversation

@jmorris-uk
Copy link
Copy Markdown
Contributor

@jmorris-uk jmorris-uk commented May 12, 2026

Description

Minor change to documentation pages to reflect:

  • there is no longer a "default" process IN.DAT and
  • if process is run with no input file given it no longer will look for a file called IN.DAT, it will run process --help.

Checklist

I confirm that I have completed the following checks:

  • My changes follow the PROCESS style guide
  • I have justified any large differences in the regression tests caused by this pull request in the comments.
  • I have added new tests where appropriate for the changes I have made.
  • If I have had to change any existing unit or integration tests, I have justified this change in the pull request comments.
  • If I have made documentation changes, I have checked they render correctly.
  • I have added documentation for my change, if appropriate.

@jmorris-uk jmorris-uk requested a review from a team as a code owner May 12, 2026 12:21
@jmorris-uk jmorris-uk linked an issue May 12, 2026 that may be closed by this pull request
@clmould clmould self-assigned this May 12, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 50.23%. Comparing base (60443bd) to head (378ed99).
⚠️ Report is 19 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4241      +/-   ##
==========================================
- Coverage   51.40%   50.23%   -1.18%     
==========================================
  Files         151      151              
  Lines       30055    29365     -690     
==========================================
- Hits        15451    14752     -699     
- Misses      14604    14613       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Collaborator

@clmould clmould left a comment

Choose a reason for hiding this comment

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

A bit of rearranging please (see comments)

Also, there is a reference to a default IN.DAT in input-guide.md - could this be removed as well please?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

While you're here, could you update this list of output files please as this is no longer correct, eg here are the outputs I got from running examples/data/large_tokamak_IN.DAT with --full-output:

Image

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

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

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

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

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

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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This can be moved further down (see later comment), so this section can begin with 'The user can provide a named input file...'

Comment thread documentation/source/usage/running-process.md
Comment thread documentation/source/usage/running-process.md
Comment thread documentation/source/usage/running-process.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Default IN.DAT doesn't work

3 participants