Difference between revisions of "JUSTUS2/Software/Orca"

From bwHPC Wiki
Jump to: navigation, search
(Created page with "<!--{| align="right" {{Table|width=40%}} --> {|{{Softwarebox}} |- ! colspan="2" style="text-align:center" | Name |- | module load | category/name <!-- Neben CIS auch berei...")
 
(Miscellaneous Notes to Usage)
 
(123 intermediate revisions by 5 users not shown)
Line 1: Line 1:
  +
{{Softwarepage|chem/orca}}
<!--{| align="right" {{Table|width=40%}} -->
 
  +
{|{{Softwarebox}}
 
  +
{| width=600px class="wikitable"
 
|-
 
|-
  +
! Description !! Content
! colspan="2" style="text-align:center" | Name
 
 
|-
 
|-
 
| module load
 
| module load
  +
| chem/orca/5.0.4
| category/name
 
<!-- Neben CIS auch bereits über Kategorien abgedeckt
 
 
|-
 
|-
 
| Availability
 
| Availability
  +
| [[bwUniCluster]] &#124; [[JUSTUS2]]
| [[bwUniCluster]] [[bwForCluster ENM]], [[bwForCluster MLS/WISO]], [[bwForCluster Theochem]], [[bwForCluster BinAC]]
 
-->
 
 
|-
 
|-
 
| License
 
| License
  +
| [https://orcaforum.kofo.mpg.de/app.php/privacypolicy/policy EULA]
| e.g. GPL
 
 
|-
 
|-
 
|Citing
 
|Citing
  +
| As described in the [https://www.kofo.mpg.de/970274/orca_manual_5_0_4.pdf manual]. Refer to Chapter 'Publications Related to ORCA' for guidance on citation.
|
 
 
|-
 
|-
 
| Links
 
| Links
| [https://some.homepage.edu Homepage]; [https://some.other.page.edu Documentation]
+
| [https://orcaforum.kofo.mpg.de/app.php/portal Main ORCA Forum Portal] &#124; [https://www.kofo.mpg.de/970274/orca_manual_5_0_4.pdf Documentation]
|
 
 
|-
 
|-
 
| Graphical Interface
 
| Graphical Interface
  +
| No
| No (Yes) <!-- Yes could link to some x11-forwarding/vnc instructions -->
 
|-
 
| Included in module
 
| <!-- mention if there is more than one software in the module, i.e. icc, ifort and debugger -->
 
 
|}
 
|}
 
== Description ==
 
'''Softwarename''' is used for worbeling the worbels. It makes use of advanced flubberdiflaps .
 
 
<br>
 
<br>
  +
= Description =
   
  +
'''ORCA''' is a comprehensive, fully parallelized quantum chemistry package designed for advanced electronic structure methods. It encompasses density functional theory, many-body perturbation theory, coupled cluster methods, multireference methods, and semi-empirical quantum chemistry approaches. ORCA is capable of computing a wide range of molecular properties and serves as a fully integrated system for multi-level calculations, including QM/MM, ONIOM, and embedded crystals.
This paragraph should give a short description of what the software does and should enable potential new users to decide if this is the software that might help them with their project.
 
   
  +
Additionally, ORCA offers several advanced features to improve computational efficiency and accuracy. These include local correlation methods, starting with PNOs and expanded to DLPNO to reduce the computational cost of coupled cluster calculations. It also incorporates RIJCOSX for efficient handling of Hartree-Fock based methods.
== Versions and Availability ==
 
A current list of the versions available on the bwUniCluster and bwForClusters can be obtained from the Cluster Information System: [http://cis-hpc.uni-konstanz.de/prod.cis/softwarename CIS Information on Softwarename]
 
   
  +
Furthermore, ORCA provides NEB-TS for studying reaction pathways and offers various methods for accurately calculating excited states, such as TD-DFT, EOM-CCSD, STEOM-CCSD, CASSCF with NEVPT2 or CASPT2, as well as molecular dynamics and multi-scale QM-MM models.
On the command line interface of any bwHPC cluster, a list of the available i versions using
 
<pre>
 
$ module avail category/softwarename
 
</pre>
 
<br>
 
   
  +
Please refer to documentation provided by the ORCA developers in the first place for more detailed information, e.g.:
== License ==
 
   
  +
[https://www.kofo.mpg.de/970274/orca_manual_5_0_4.pdf Orca Manual 5.0.4]
Anything specific to the licensing model goes here. If the Program is GPL or one of the over very common free software licenses, you can probably remove this section. Things that should be mentioned here (if they apply)
 
- does the software use a license server
 
- if yes, how many concurrent licenses can we use
 
- are there other restrictions on the license (most proprietary software run on Universitiescan only be used for non-commercial research or teaching purposes)
 
- Do any other restrictions apply
 
 
== Usage ==
 
=== Loading the module ===
 
You can load the default version of ''software name'' with the command
 
<pre>
 
$ module load category/softwarename
 
</pre>
 
 
The module will try to load modules it needs to function (e.g. compiler/intel). If loading the module fails, check if you have already loaded one of those modules, but not in the version needed for ''software name''.
 
If you wish to load a specific (older) version, you can do so using e.g.
 
<pre>
 
$ module load category/softwarename/0.0.0
 
</pre>
 
to load the version 0.0.0.
 
 
<br>
 
<br>
  +
[https://wires.onlinelibrary.wiley.com/doi/full/10.1002/wcms.1606 Article Overview by Frank Nesse]
 
=== Program Binaries ===
 
=== Disk Usage ===
 
Scratch files are written to the current directory by default.
 
Please change to a local directory before starting your calculations. For example
 
<pre>
 
$ mkdir -p /tmp/$USER/job_sub_dir
 
$ cd /tmp/$USER/job_sub_dir
 
</pre>
 
 
In case of multi-node parallel jobs, you might need to create the directory on all nodes used.
 
 
<br>
 
<br>
  +
[https://wires.onlinelibrary.wiley.com/doi/10.1002/wcms.81 Article about main improvement in the version 5.0]
   
== Examples ==
 
You can copy a simple interactive example to your home directory and run it, using:
 
<pre>
 
$ mkdir ~/SOFTWARENAME-examples/
 
$ cp -r $SOFTWARENAME_EXA_DIR/ ~/SOFTWARENAME-examples/
 
$ cd ~/SOFTWARENAME-examples/
 
$ blabla
 
</pre>
 
 
<br>
 
<br>
   
  +
= Miscellaneous Notes to Usage =
== Version-Specific Information ==
 
  +
* ORCA utilizes MPI parallelization, specifically backed by OpenMPI. When configuring parallel jobs in the Slurm sbatch script, use appropriate directives such as --nodes and --ntasks-per-node.<br>Avoid using the --cpus-per-task directive. All the ORCA modules load the appropriate OpenMPI module automatically.
For information specific to a single version, see the information available via the module system with the command
 
  +
* To ensure successful parallel runs, it is necessary to call ORCA with the full path, i.e. '$ORCA_BIN_DIR/orca <input_file>'
<pre>
 
  +
* Due to potential large I/O operations, especially for post HF methods, it is advisable to place temporary files a local scratch directory.<br>To learn more about local disk space on [[JUSTUS2]], please refer to the [[JUSTUS2/Hardware#$SCRATCH and $TMPDIR|$SCRATCH and $TMPDIR]] section on the "JUSTUS2 Hardware" page.
$ module help category/softwarename
 
  +
* The most preferable way to load ORCA is with the specific version included, i.e., 'module load chem/orca/<version>'.<br>The default version, which may change over time, can be loaded simply with the command 'module load chem/orca'.
</pre>
 
  +
* The module includes the loading of all additional modules, especially an appropriate OpenMPI module in the case of ORCA, necessary for the proper functioning of the program, so there's no need to load additional modules separately. However, loading additional modules may be counterproductive.
 
<br>
 
<br>
 
----
 
[[Category:Chemistry software]][[Category:bwUniCluster]][[Category:bwForCluster_Chemistry]]
 

Latest revision as of 15:51, 29 February 2024

The main documentation is available via module help chem/orca on the cluster. Most software modules for applications provide working example batch scripts.


Description Content
module load chem/orca/5.0.4
Availability bwUniCluster | JUSTUS2
License EULA
Citing As described in the manual. Refer to Chapter 'Publications Related to ORCA' for guidance on citation.
Links Main ORCA Forum Portal | Documentation
Graphical Interface No


1 Description

ORCA is a comprehensive, fully parallelized quantum chemistry package designed for advanced electronic structure methods. It encompasses density functional theory, many-body perturbation theory, coupled cluster methods, multireference methods, and semi-empirical quantum chemistry approaches. ORCA is capable of computing a wide range of molecular properties and serves as a fully integrated system for multi-level calculations, including QM/MM, ONIOM, and embedded crystals.

Additionally, ORCA offers several advanced features to improve computational efficiency and accuracy. These include local correlation methods, starting with PNOs and expanded to DLPNO to reduce the computational cost of coupled cluster calculations. It also incorporates RIJCOSX for efficient handling of Hartree-Fock based methods.

Furthermore, ORCA provides NEB-TS for studying reaction pathways and offers various methods for accurately calculating excited states, such as TD-DFT, EOM-CCSD, STEOM-CCSD, CASSCF with NEVPT2 or CASPT2, as well as molecular dynamics and multi-scale QM-MM models.

Please refer to documentation provided by the ORCA developers in the first place for more detailed information, e.g.:

Orca Manual 5.0.4
Article Overview by Frank Nesse
Article about main improvement in the version 5.0


2 Miscellaneous Notes to Usage

  • ORCA utilizes MPI parallelization, specifically backed by OpenMPI. When configuring parallel jobs in the Slurm sbatch script, use appropriate directives such as --nodes and --ntasks-per-node.
    Avoid using the --cpus-per-task directive. All the ORCA modules load the appropriate OpenMPI module automatically.
  • To ensure successful parallel runs, it is necessary to call ORCA with the full path, i.e. '$ORCA_BIN_DIR/orca <input_file>'
  • Due to potential large I/O operations, especially for post HF methods, it is advisable to place temporary files a local scratch directory.
    To learn more about local disk space on JUSTUS2, please refer to the $SCRATCH and $TMPDIR section on the "JUSTUS2 Hardware" page.
  • The most preferable way to load ORCA is with the specific version included, i.e., 'module load chem/orca/<version>'.
    The default version, which may change over time, can be loaded simply with the command 'module load chem/orca'.
  • The module includes the loading of all additional modules, especially an appropriate OpenMPI module in the case of ORCA, necessary for the proper functioning of the program, so there's no need to load additional modules separately. However, loading additional modules may be counterproductive.