1
0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-22 12:23:54 +01:00
Go to file
2021-05-04 20:22:58 +02:00
.github/workflows avoid cloning htmlize 2021-04-12 16:18:49 +02:00
docs rm gitignore in docs 2021-04-12 14:31:05 +02:00
include update gitignore 2021-05-03 15:06:30 +02:00
lib add gitignore 2021-04-30 16:21:13 +02:00
src more portable HDF5 back end 2021-05-04 20:22:58 +02:00
tests fixed make install and introduced uninstall targets 2021-05-03 15:15:49 +02:00
tools more portable HDF5 back end 2021-05-04 20:22:58 +02:00
.gitignore Autoconfig with optional HDF5 compilation (#42) 2021-04-28 15:30:18 +02:00
.gitmodules org-mode to html conversion for the documentation website (#41) 2021-04-09 16:45:44 +02:00
configure.ac updated FCFLAGS when HDF5 is found with pkg-config 2021-05-03 15:05:54 +02:00
LICENSE Initial commit 2021-01-18 15:48:36 +01:00
Makefile.in fixed make install and introduced uninstall targets 2021-05-03 15:15:49 +02:00
README.md added minimal requirements 2021-05-03 15:58:01 +02:00
trex.json Update trex.json 2021-04-20 01:29:31 +02:00

TREXIO

TREX library fo efficient I/O.

Minimal requirements (for users):

  • Autoconf
  • C compiler (gcc/icc/clang)
  • Fortran compiler (gfortran/ifort/flang)

Installation procedure from the tarball (for users):

  1. Download the trexio-<version>.tar.gz file
  2. gzip -cd trexio-<version>.tar.gz | tar xvf -
  3. cd trexio-<version>
  4. ./configure
  5. make && sudo make install
  6. make check

Note: on systems with no sudo rights access, one can replace ./configure with ./configure prefix=${PWD} in order to execite make install/uninstall commands without sudo. This will enable the installation in the root directory of the library.

Additional requirements (for developers):

  • Automake
  • python3 (>=3.6)
  • emacs (>=26.0)

Installation procedure from the GitHub repo clone (for developers):

  1. git clone https://github.com/TREX-CoE/trexio.git
  2. cd trexio
  3. cd tools && ./build_trexio.sh && cd ..
  4. autoreconf
  5. automake --add-missing --copy
  6. ./configure
  7. make && sudo make install
  8. make check

Tutorial

TODO

Technical documentation

Documentation generated from TREXIO org-mode files

Miscellaneous

Note: The code should be compliant with the C99 CERT C coding standard. This can be checked with the cppcheck tool.