Skip to content

Commit

Permalink
Manuscript edits
Browse files Browse the repository at this point in the history
  • Loading branch information
kmlefran committed Sep 5, 2024
1 parent 768918b commit 5d496b9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
9 changes: 9 additions & 0 deletions paper.bib
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,15 @@ @article{aiida
volume = 7,
doi = {10.1038/s41597-020-00638-4}
}
@article{klg,
title = {
{Toward Universal Substituent Constants: Relating QTAIM Functional Group Descriptors to Substituent Effect Proxies}},
author = { Kevin M. Lefrancois-Gagnon and Robert C. Mawhinney},
year = 2023,
journal = {Journal of Chemical Information and Modeling},
volume = 63,
doi = {10.1021/acs.jcim.3c00987}
}
@software{AIMAll,
author = {Todd A. Keith},
year = 2019,
Expand Down
11 changes: 5 additions & 6 deletions paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,7 @@ with Gaussian software outputs [@gaussian], a versatile workflow enabling interf
other quantum chemistry packages is also made available.

Through a variety of workflows that can start with an .xyz file, AiiDA `StructureData`, or even with
a SMILES string of a molecule, `aiida-aimall` provides a variety of use cases for automating
and complex workflows. Additionally, tools to ensure that computers are not overloaded through
a SMILES string of a molecule, `aiida-aimall` provides a variety of use cases for automating complex workflows. Additionally, tools to ensure that computers are not overloaded through
too many simultaneous processes are made availabe through classes of `FromGroupSubmissionController`s
from `aiida-submission-controller` to limit active processes.

Expand All @@ -69,7 +68,7 @@ Some of the workflows in `aiida-aimall` automate calculation of substituent prop

## Integrations with Computational Chemistry Software

`aiida-aimall`'s main draw is that it enables automation to link the outputs of standard computational chemistry software directly to an AIMAll calculation. A list of provided workflows is shown in Table 1. The software with the most robust implementation is Gaussian software,[@gaussian] as Gaussian already has an implemented `aiida` package. Other computational chemistry software like ORCA can be run through the `QMToAIMWorkchain`, which uses `aiida-shell` to run software than can be run through the command line. If .molden or .cp2k output formats are available, one could alternatively use these to generate the needed .wfx files for AIMAll, and automatically run AIMAll through the `GenerateWFXToAIMWorkchain`.
`aiida-aimall`'s main draw is that it enables automation to link the outputs of standard computational chemistry software directly to an AIMAll calculation. A list of provided workflows is shown in Table 1. The software with the most robust implementation is Gaussian software,[@gaussian] as Gaussian already has an implemented `aiida` package. Other computational chemistry software like ORCA can be run through the `QMToAIMWorkchain`, which uses `aiida-shell` to run software than can be run through the command line. If .molden or .cp2k.out output formats are available, one could alternatively use these to generate the needed .wfx files for AIMAll, and automatically run AIMAll through the `GenerateWFXToAIMWorkchain`.

Table 1: Main workflows provided by `aiida-aimall`, their `aiida` entry points that can be used to load them by `aiida.plugins.WorkflowFactory`, and a brief description. These workflows all end with the output of an `AimqbCalculation` as their main output.[]{label="workflows"}

Expand All @@ -91,13 +90,13 @@ Table 1: Main workflows provided by `aiida-aimall`, their `aiida` entry points t
+---------------------------------+-----------------+------------------------------+
| `SubstituentParameterWorkChain` | aimall.subparam | Compute substituent \ |
| | | properties defined by \ |
| | | the authors automatically |
| | | the authors[@klg] automatically |
+:===============================:+:===============:+:============================:+


## Controllers to limit computer burden when running large numbers of jobs
The last main contribution of `aiida-aimall` is through the definition of `FromGroupSubmissionController`s from the `aiida-submission-controller` package. These controllers limit active processes and can be used together as
demonstrated in (the example notebook) to automate the entire `SubstituentParameterWorkchain`. These use a number of `Workchains` developed just for their use in these controllers. The process flows as `SmilesToGaussianController` -> `AIMAllReorController` -> `GaussianController` -> `AIMAllController`. The latter two controllers can also be seen and used as general use controllers wrapping `GaussianCalculations` and `AimqbCalculations`
The last main contribution of `aiida-aimall` is through the definition of <br/><br/>`FromGroupSubmissionController`s from the `aiida-submission-controller` package. These controllers limit active processes and can be used together as
demonstrated in [a tutorial notebook](https://aiida-aimall.readthedocs.io/en/latest/tutorials/controllers.html)) to automate the entire `SubstituentParameterWorkchain`. These use a number of `Workchains` developed just for their use in these controllers. The process flows as `SmilesToGaussianController` -> `AIMAllReorController` -> `GaussianController` -> `AIMAllController`. The latter two controllers can also be seen and used as general use controllers wrapping `GaussianCalculations` and `AimqbCalculations`

# Acknowledgements

Expand Down

0 comments on commit 5d496b9

Please sign in to comment.