Skip to content

Commit cf4fb0f

Browse files
karmachoicheolhochoi
andauthored
docs: update README and PyOQP manuals (#138)
* docs: update README and PyOQP manuals * docs: leave SOC documentation to SOC PR --------- Co-authored-by: cheolhochoi <cheolhochoi@ultra.tailbd750b.ts.net>
1 parent 9daa693 commit cf4fb0f

2 files changed

Lines changed: 76 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Open Quantum Platform ([OpenQP](https://pubs.acs.org/doi/10.1021/acs.jctc.4c0111
1111
- **New Exchange-Correlation Functionals** of [**DTCAM** series](https://doi.org/10.1021/acs.jctc.4c00640) for MRSF-TDDFT
1212
- **Ground State Properties** by HF and DFT theories
1313
- **Geometry Optimization, Transition State Search, and Conical Intersection Search** by SciPy and [DL-Find](https://github.com/digital-chemistry-laboratory/libdlfind)
14+
- [geomeTRIC](https://github.com/leeping/geomeTRIC) optimizer backend for state-specific optimization, MECI, MECP, transition-state searches, constrained optimizations, and IRC paths
1415
- [PyRAI2MD](https://github.com/mlcclab/PyRAI2MD-hiam) Integration to support Artificial Intelligence Ab Initio Molecular Dynamics
1516
- [LibXC](https://gitlab.com/libxc/libxc) Integration to support a variety of exchange-correlation functionals
1617
- [basis_set_exchange](https://github.com/MolSSI-BSE/basis_set_exchange) Integration to support a variety of basis sets
@@ -20,6 +21,8 @@ Open Quantum Platform ([OpenQP](https://pubs.acs.org/doi/10.1021/acs.jctc.4c0111
2021
- **OpenMP and MPI Parallelization** and **BLAS/LAPACK Optimization** for high performance
2122
- [OpenTrustRegion library](https://github.com/eriksen-lab/opentrustregion) for stable SCF convergence
2223
- Native PySCF-based advanced initial guesses, plus optional [MOKIT](https://github.com/1234zou/MOKIT) support for broader external wavefunction conversion workflows
24+
- Native PySCF-backed initial guesses: `guess.type=pyscf`, `guess.type=sad`, and `guess.type=sap`
25+
- [OpenqpView](https://open-quantum-platform.github.io/OpenqpView/) browser-based visualization for OpenQP outputs, supporting local log, JSON, Molden, cube, and XYZ inspection
2326

2427
### Upcoming Features
2528
- **Efficient electrostatic embedding QM/MM** by [ESPF QM/MM](https://doi.org/10.1063/5.0133646)
@@ -132,6 +135,9 @@ For more in-depth information, visit:
132135
### Input Generator
133136
Easily create input files for OpenQP using our [Web-based Input Generator](https://open-quantum-platform.github.io/OpenQP_Input_Generator/).
134137

138+
### OpenqpView
139+
Inspect OpenQP calculation outputs directly in the browser with [OpenqpView](https://open-quantum-platform.github.io/OpenqpView/). Recent OpenqpView development added a GitHub Pages deployment, full-periodic-table molecule rendering, local file/drop/paste loading, WebGL auto-spin controls, and support for OpenQP log, JSON, Molden, cube, and XYZ data. Files and pasted text are processed locally in the browser and are not uploaded to a server.
140+
135141
### Citing OpenQP
136142
If you use OpenQP in your research, please cite the following papers:
137143

pyoqp/README.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
- Geometry optimization for arbitrary state local minimum, MECI, MEP with Scipy library
88
- Geometry optimization for arbitrary state local minimum, MECI, TS with DL-FIND library
9+
- Geometry optimization with geomeTRIC for state-specific optimization, MECI, MECP, TS, constrained optimizations, and IRC paths
10+
- Native PySCF-backed initial guesses: `pyscf`, `sad`, and `sap`
911
- Energy gradient calculations interface for nonadiabatic molecular dynamics
1012

1113
## Prerequisite
@@ -81,6 +83,18 @@ Results, including log files and `test_report.txt`, will be stored in the curren
8183
save_mol=False
8284
continue_geom=False
8385

86+
[geometric]
87+
coordsys=tric
88+
trust=0.1
89+
tmax=0.3
90+
convergence_set=GAU
91+
prefix=geometric
92+
hessian=never
93+
irc_direction=forward
94+
constraints_file=''
95+
enforce=0.0
96+
conmethod=0
97+
8498
[scf]
8599
type=rhf
86100
maxit=30
@@ -188,6 +202,7 @@ input section handle the basic information of molecular system
188202
meci minimum energy conical intersection optimization
189203
mep minimum energy path calculation
190204
ts transition state optimization
205+
irc intrinsic reaction coordinate with [optimize]lib=geometric
191206
neb nudge elasted band calculation (not avaialble yet)
192207

193208
- system // specify molecular structure or xyz file
@@ -217,6 +232,14 @@ guess section handle the guess orbitals
217232
hcore hcore guess
218233
model read orbital from molden
219234
json load data from json
235+
auto load json if the requested file exists; otherwise use huckel
236+
pyscf run a PySCF SCF calculation and import the converged orbitals
237+
sad build a PySCF superposition-of-atomic-density initial guess
238+
sap build a PySCF superposition-of-atomic-potential initial guess
239+
240+
pyscf, sad, and sap use the native OpenQP JSON restart exporter.
241+
PySCF is installed with OpenQP's Python dependencies. MOKIT is not
242+
required for these initial guesses.
220243

221244
- file // set the guess orbital or data file
222245

@@ -384,6 +407,7 @@ optimize section handle the geometry optimization
384407

385408
scipy use scipy.optimize library (default)
386409
dlfind use DL-FIND library
410+
geometric use geomeTRIC. Supports runtype=optimize, meci, mecp, ts, and irc
387411

388412
- optimizer // choose the scipy optimizer
389413

@@ -463,6 +487,52 @@ optimize section handle the geometry optimization
463487
True do initial SCF iterations in every optimization step
464488
False do not do initial SCF iterations after the first optimization step
465489

490+
### [geometric]
491+
492+
geometric section controls the geomeTRIC optimizer backend when [optimize]lib=geometric
493+
494+
- coordsys // coordinate system passed to geomeTRIC
495+
496+
tric translation-rotation internal coordinates (default)
497+
498+
- trust // initial trust radius in Angstrom
499+
500+
0.1 (default)
501+
502+
- tmax // maximum trust radius in Angstrom
503+
504+
0.3 (default)
505+
506+
- convergence_set // geomeTRIC convergence preset
507+
508+
GAU (default)
509+
510+
- prefix // prefix for geomeTRIC output files
511+
512+
geometric (default)
513+
514+
- hessian // initial Hessian option passed to geomeTRIC
515+
516+
never (default for minima and constrained optimization)
517+
first (recommended/automatically used for ts and irc if hessian=never)
518+
519+
- irc_direction // IRC branch direction for runtype=irc
520+
521+
forward (default)
522+
backward
523+
524+
- constraints_file // geomeTRIC constraints file for constrained optimization
525+
526+
relative paths are resolved relative to the OpenQP input file
527+
528+
- enforce // geomeTRIC constraint enforcement value
529+
530+
0.0 (default)
531+
532+
- conmethod // geomeTRIC constraint method
533+
534+
0 (default)
535+
466536
### [dlfind]
467537

468538
dlfind section handle the DL-FIND library for geometry optimization

0 commit comments

Comments
 (0)