Skip to content

Commit 1116b47

Browse files
authored
Update README.md
1 parent 2b5f80e commit 1116b47

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

Diff for: README.md

+21-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
11
# Batch ORCA Script, by Rac Mukkamala
22

33
## Description
4-
A Bash script to submit batch jobs to the ab initio ORCA software. Automatically checks for syntax errors in input files and ORCA runtime crashes. Organizes ORCA files into individual directories. Created by Rac Mukkamala
5-
6-
## Details
7-
4+
A Bash script to submit batch jobs and batch OpenMPI jobs to the ab initio ORCA software. Automatically checks for syntax errors in input files, and can also identify ORCA runtime crashes. Provides a list of failed ORCA jobs at the end for easy troubleshooting. Organizes ORCA files into individual directories. Created by Rac Mukkamala
85

96
## Params
10-
7+
The `batch_orca_params.txt` file specifies the full path to ORCA as well as the preferred ORCA input header for input file syntax checking. The format of this params file is shown below:
8+
```
9+
PATH: /bin/the/path/to/orca
10+
HEADER: ! B3LYP OPT def2-SVP NormalPrint Grid4 *NormalSCF PAL4
11+
```
12+
- If your ORCA is added to the `$PATH` environment variable and if you are not using OpenMPI, then for the `PATH: ` row in `batch_orca_params` you can just write `orca`. Otherwise, make sure you write out the full path to ORCA. OpenMPI will only run if you write out the full ORCA path!
13+
- Enter the entire desired ORCA header into the `HEADER: ` row. If you are running a geometry optimization with DFT, B3LYP functional, and OpenMPI parallel processing, you can just copypaste the example header into the `batch_orca_params.txt` file.
14+
- Do not change the file name for the `batch_orca_params.txt` file! Additionally, make sure that the `batch_orca_params.txt` is at the same directory level as the bash script.
15+
16+
## Recommended File Structure
17+
```
18+
[root directory]
19+
orcabatch.sh
20+
batch_orca_params.txt
21+
[input file directory]
22+
file1.inp
23+
file2.inp
24+
file3.inp
25+
[...].inp
26+
```
1127

1228
## Running the script
1329
1. Set up the file structure outlined above

0 commit comments

Comments
 (0)