Skip to content

Additional section in the README.md to ensure users use the appropriate command blocks #13

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
pwnusmaximus wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Additional section in the README.md to ensure users use the appropriate command blocks #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ Compound scripts allow the user to automate complicated workflows directly withi

Also, a complicated workflow can be run in a single computation---no need to wait for finished jobs and resubmissions.

## Special Formatting and file extention note
1. While the extention of your input files can be anything, It's recommedned to keep them to the traditional ".inp" (input) or ".cmp" (compound) extentions.
2. While not shown in any of the following examples, a compound script REQUIRES the `%Compound` block to come before any variables. Additionally, if you desire your job to be multi-threaded you will need the `%maxcore` and `%Pal NPROCSHARED` blocks to be above the `%Compound` block
3. Note the `%maxcore` and `%Pal NPROCSHARED` blocks can only be supplied once. All subsequent New_Step sections will re-use the same memory and number of CPUs.

## How do I contribute?

Expand Down