Skip to content

Commit 20e9d50

Browse files
authored
Revise README for clarity and community support
Updated README to improve structure and clarity, added community support links, and revised citation instructions.
1 parent 2520e90 commit 20e9d50

File tree

1 file changed

+73
-27
lines changed

1 file changed

+73
-27
lines changed

README.md

Lines changed: 73 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,26 @@
22

33
[![Build Status](https://travis-ci.org/Quantum-Dynamics-Hub/libra-code.svg?branch=master)](https://travis-ci.org/Quantum-Dynamics-Hub/libra-code)
44

5-
65
This is the main page of the computational chemistry methodology discovery library, Libra
7-
The program website is [here](https://quantum-dynamics-hub.github.io/libra/index.html)
86

9-
## Info
7+
## About
108

11-
More:
9+
* [extensive tutorials, example, and documentation](https://github.com/compchem-cybertraining/Tutorials_Libra).
10+
This resource is actively developed, but the older tutorials may not fully reflect the current stage of the code itself, so the
11+
tutorials demonstrating the older features may be failing - please let us know if you need to use any of those and run into problems.
1212

13-
* [Training & Usage](https://github.com/compchem-cybertraining/Tutorials_Libra)
14-
* [Autogenerated Documentation](https://quantum-dynamics-hub.github.io/libra-code/)
13+
* [old program website](https://quantum-dynamics-hub.github.io/libra/index.html)
14+
Not maintained for long time, but may still contain some useful info on some topics
1515

16+
## Community and Support
1617

17-
Due to the increased volume of technical questions about installing and using the
18-
Libra, Libra-X, Pyxaid and Pyxaid2 codes, I have decided to create a convenient
19-
[public forum](https://groups.google.com/forum/#!forum/quantum-dynamics-hub)
20-
for all users with the intent:
18+
* Click below to join our community:
19+
👉 [Join Slack](https://join.slack.com/t/quantumdynamicshub/shared_invite/zt-mjbhjssx-GGhsbYHxeBMvhmumK_j7LA)
2120

22-
- to share my replies with not only a single user that have a trouble, but also other
23-
potential users who may found that information useful;
21+
* Open an Issue - to ask questions or report a problem
2422

25-
- so that the users/developers who have had some experience with the code would be able to share their
26-
knowledge and skills with others;
23+
* The following [public forum](https://groups.google.com/forum/#!forum/quantum-dynamics-hub) exists, but
24+
hasn't been used for a while - use the Slack workspace instead
2725

2826

2927
## Installation Videotutorials (as of 5/16/2022)
@@ -38,8 +36,6 @@ for all users with the intent:
3836

3937
* [Installing Libra](https://ub.hosted.panopto.com/Panopto/Pages/Embed.aspx?id=7f8dd8c4-9f58-4ca0-a8cb-ae930166b7ec&autoplay=false&offerviewer=true&showtitle=true&showbrand=true&captions=false&interactivity=all)
4038

41-
42-
4339
## Installation (as of after 3/23/2023)
4440

4541
### 1. Install miniconda (for Python 3.9) and activate Conda
@@ -326,29 +322,79 @@ installation instructions:
326322

327323
This code is provided in the hope it will be useful.
328324

329-
If you use the code in your research, please cite the following paper(s):
330-
331-
### Papers that describe Libra or its features
325+
If you use Libra in your research, please cite the following paper:
332326

327+
### The "main" Libra papers
328+
* [More recent overview of Libra's capabilities](https://doi.org/10.1016/j.simpa.2022.100445)
329+
Shakiba, M.; Smith, B.; Li, W.; Dutra, M.; Jain, A.; Sun, X.; Garashchuk, S.; Akimov, A.V.* "Libra: A modular software library for quantum
330+
nonadiabatic dynamics" *Software Impacts* **2022** 14, 100445
331+
333332
* [The initial implementation](http://onlinelibrary.wiley.com/doi/10.1002/jcc.24367/full)
334333
Akimov, A. V. "Libra: An open-Source 'methodology discovery' library for quantum and classical dynamics simulations"
335334
*J. Comput. Chem.* **2016** 37, 1626-1649
336335

337-
* [Phase correction, Ehrenfest dynamics details, basis transformations (see the SI)](https://doi.org/10.1021/acs.jpclett.8b02826)
338-
Akimov, A. V.; "A Simple Phase Correction Makes a Big Difference in Nonadiabatic Molecular Dynamics"
339-
*J. Phys. Chem. Lett.* **2018** 9, 6096-6102
336+
If you use any of the Libra's methods or implementation, please cite as appropriate:
340337

341-
* [Belyaev-Lebedev-Landau-Zener Surface Hopping within the Neglect of Back-Reaction Approximation](https://pubs.acs.org/doi/10.1021/acs.jpclett.9b03687)
342-
Smith, B.; Akimov, A. V. "Hot Electron Cooling in Silicon Nanoclusters via Landau-Zener Non-Adiabatic Molecular Dynamics:
343-
Size Dependence and Role of Surface Termination" *J. Phys. Chem. Lett.* **2020** 11, 1456-1465
338+
### Papers that describe various developments in Libra
339+
* [FISH: Fully-integrated surface hopping](https://doi.org/10.1021/acs.jpclett.5c01509)
340+
Han, D.; Shakiba, M.; Akimov, A. V. "Fully-Integrated Surface Hopping as Quantum Decoherence Correction in Nonadiabatic Dynamics"
341+
*J. Phys. Chem. Lett.* **2025** 16, 7168-7176
342+
343+
* [Multiple-state QTSH](https://doi.org/10.1021/acs.jctc.4c01751)
344+
Han, D.; Martens, C. C.; Akimov, A. V. "Generalization of Quantum-Trajectory Surface Hopping to Multiple Quantum States"
345+
*J. Chem. Theory Comput.* **2025** 20, 5022-5042
346+
347+
* [F-tracking of excited states](https://pubs.acs.org/doi/10.1021/acs.jpclett.4c02909)
348+
Akimov, A. V. "State Tracking in Nonadiabatic Molecular Dynamics Using Only Forces and Energies"
349+
*J. Phys. Chem. Lett.* **2024** 15, 11944-11953
350+
351+
* [FSSH-3, modified FSSH-2, implmenentation of GFSH](https://www.tandfonline.com/doi/full/10.1080/00268976.2024.2376893)
352+
Akimov, A. V. "The Fewest Switches Surface Hopping as An Optimization Problem" *Mol. Phys.* **2024** e2376893
353+
354+
* [Exact Factorization methods: SHXF, MQCXF, MFXF](https://doi.org/10.1021/acs.jctc.4c00343)
355+
Han, D.; Akimov, A.V. "Nonadiabatic Dynamics with Exact Factorization: Implementation and Assessment."
356+
*J. Chem. Theory Comput.* **2024** 20, 5022–5042
357+
358+
* [ML Hamiltonian mapping approach](https://doi.org/10.1021/acs.jctc.4c00008)
359+
Shakiba, M.; Akimov, A.V. "Machine-Learned Kohn–Sham Hamiltonian Mapping for Nonadiabatic Molecular Dynamics."
360+
*J. Chem. Theory Comput.* **2024** 20, 2992–3007
361+
362+
* [TC-NBRA](https://doi.org/10.1021/acs.jpclett.3c03029)
363+
Akimov, A.V. "Energy-Conserving and Thermally Corrected Neglect of Back-Reaction Approximation Method for Nonadiabatic Molecular Dynamics"
364+
*J. Phys. Chem. Lett.* **2023** 14, 11673-11683
365+
366+
* [QTAG](https://doi.org/10.1002/qua.27078)
367+
Dutra, M.; Garshchuk, S.; Akimov, A. "The Quantum Trajectory-guided Adaptive Gaussian Methodology in the Libra Software Package"
368+
*Int. J. Quntum Chem.* **2023.** 123, e27078
369+
370+
* [(generalized) Local diabatization](https://doi.org/10.1007/s00214-023-03007-7)
371+
Shakiba, M.; Akimov, A.V. "Generalization of the Local Diabatization Approach for Propagating Electronic Degrees of Freedom in Nonadiabatic Dynamics"
372+
*Theor. Chem. Acc.* **2023** 142, 68
373+
374+
* [xTB from cp2k/Libra interface for NA-MD in large-scale systems, k-point formulation, spin-adaptation](https://doi.org/10.1021/acs.jctc.2c00297)
375+
Shakiba, M.; Stippel, E.; Li, W.; Akimov, A. V. "Nonadiabatic Molecular Dynamics with Extended Density Functional Tight-Binding:
376+
Application to Nanocrystals and Periodic Solids" *J. Chem. Theory Comput.* **2022** 18, 5157-5180
377+
378+
* [many-body effects, NA-MD with TD-DFT states](https://pubs.acs.org/doi/10.1021/acs.jctc.0c01009)
379+
Smith, B.; Shakiba, M.; Akimov, A. V. "Nonadiabatic Dynamics in Si and CdSe Nanoclusters: Many-Body vs. Single-Particle
380+
Treatment of Excited States" *J. Chem. Theory. Comput.* **2021** 17, 678-693
344381

345382
* [HEOM implementation](https://pubs.acs.org/doi/10.1002/qua.26373)
346383
Temen, S.; Jain, A.; Akimov, A. V. "Hierarchical equations of motion in the Libra software package"
347-
*Int. J. Quant. Chem.* **2020**
384+
*Int. J. Quant. Chem.* **2020** 120, e26373
385+
386+
* [Belyaev-Lebedev-Landau-Zener Surface Hopping within the Neglect of Back-Reaction Approximation](https://pubs.acs.org/doi/10.1021/acs.jpclett.9b03687)
387+
Smith, B.; Akimov, A. V. "Hot Electron Cooling in Silicon Nanoclusters via Landau-Zener Non-Adiabatic Molecular Dynamics:
388+
Size Dependence and Role of Surface Termination" *J. Phys. Chem. Lett.* **2020** 11, 1456-1465
389+
390+
* [Phase correction, Ehrenfest dynamics details, basis transformations (see the SI)](https://doi.org/10.1021/acs.jpclett.8b02826)
391+
Akimov, A. V.; "A Simple Phase Correction Makes a Big Difference in Nonadiabatic Molecular Dynamics"
392+
*J. Phys. Chem. Lett.* **2018** 9, 6096-6102
393+
348394

349395

350396
You may find the following papers useful examples
351-
### Parers that utilize Libra
397+
### Papers that utilize Libra
352398

353399
* [Formulation of a fragment-based NA-MD](http://pubs.acs.org/doi/abs/10.1021/acs.jctc.6b00955)
354400
Akimov, A. V. "Nonadiabatic Molecular Dynamics with Tight-Binding Fragment Molecular Orbitals"

0 commit comments

Comments
 (0)