#+TITLE: TREXIO source code documentation
#+PROPERTY: comments org
#+SETUPFILE: ../docs/theme.setup

--------------------------------
#+BEGIN_EXPORT html
<script async src="https://cse.google.com/cse.js?cx=a67f8ab65a66f97f2"></script>
<div class="gcse-search"></div>
#+END_EXPORT
--------------------------------

TREXIO is an open-source file format and library developed for the storage and
manipulation of data produced by quantum chemistry calculations. It was
designed with the goal of providing a reliable and efficient method of storing
and exchanging wave function parameters and matrix elements.

The library consists of a front-end implemented in the C programming language
and two different back-ends: a text back-end and a binary back-end utilizing
the HDF5 library enabling fast read and write speeds.  It is compatible with a
variety of platforms and has interfaces for Fortran, Python, and OCaml.

If you use TREXIO, please cite this article published in the [[https://doi.org/10.1063/5.0148161][Journal of Chemical Physics]]:
#+begin_src latex
@article{trexio_2023,
  author = {Posenitskiy, Evgeny and Chilkuri, Vijay Gopal and Ammar, Abdallah and Hapka, Micha{\l} and Pernal, Katarzyna and Shinde, Ravindra and Landinez Borda, Edgar Josu{\'{e}} and Filippi, Claudia and Nakano, Kosuke and Kohul{\'{a}}k, Otto and Sorella, Sandro and de Oliveira Castro, Pablo and Jalby, William and R{\'{\i}}os, Pablo L{\'{o}}pez and Alavi, Ali and Scemama, Anthony},
  title = {{TREXIO: A file format and library for quantum chemistry}},
  journal = {J. Chem. Phys.},
  volume = {158},
  number = {17},
  year = {2023},
  month = may,
  issn = {0021-9606},
  publisher = {AIP Publishing},
  doi = {10.1063/5.0148161}
}
#+end_src
If you don't have access to the journal, you can access the manuscript on
[[https://doi.org/10.48550/arXiv.2302.14793][arXiv:2302.14793]].

--------------------------------

#+BEGIN_EXPORT html
<table style="width:100%">
<tr><td style="width:50%">
#+END_EXPORT

   - [[./intro.html][Motivation]]
   - [[./lib.html][The TREXIO library]]
   - [[./trex.html][Data stored with TREXIO]]
   - [[./tutorial_benzene.html][Tutorial]]
   - [[./examples.html][Examples]]
   - [[./templator_front.html][Front end API]]
   - [[./templator_hdf5.html][HDF5 back end]]
   - [[./templator_text.html][TEXT back end]]

#+BEGIN_EXPORT html
</td>
<td>
<img src="trexio.png" alt="T-Rex talking about chemistry"
align="right" width="300"/>
</td></tr>
</table>
#+END_EXPORT

--------------------------------

  The source code of the library is available at
  https://github.com/trex-coe/trexio
  and bug reports should be submitted at
  https://github.com/trex-coe/trexio/issues.

  The TREXIO library is licensed under the open-source 3-clause BSD license.

------------------

  [[https://trex-coe.eu/sites/default/files/inline-images/euflag.jpg]] [[https://trex-coe.eu][TREX: Targeting Real Chemical Accuracy at the Exascale]] project has received funding from the European Union’s Horizon 2020 - Research and Innovation program - under grant agreement no. 952165. The content of this document does not represent the opinion of the European Union, and the European Union is not responsible for any use that might be made of such content.

# -*- mode: org -*-
