TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-11-03 20:54:07 +01:00
Code Issues Projects Releases Wiki Activity
350 Commits 5 Branches 16 Tags 46 MiB
C 41.1%
Python 21.6%
Rust 13.8%
Shell 5.7%
Fortran 4.5%
Other 13.3%
d637f9b738
Go to file
q-posev d637f9b738 add sections
2021-06-22 16:04:25 +02:00
.github/workflows create actions.yml for CI on Ubuntu and MacOS (#38) 2021-06-07 14:05:41 +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
m4 Improve HDF5 in configure 2021-06-03 01:25:20 +02:00
pkgconfig Improve HDF5 in configure 2021-06-03 01:25:20 +02:00
src Merge branch 'master' into unit-testing 2021-06-22 14:46:39 +02:00
tests add tests for open/close 2021-06-22 15:59:35 +02:00
tools Documentation in dist 2021-06-18 12:04:03 +02:00
.gitignore update gitignore 2021-06-16 12:04:55 +02:00
.gitmodules org-mode to html conversion for the documentation website (#41) 2021-04-09 16:45:44 +02:00
AUTHORS Typo 2021-06-02 10:44:03 +02:00
autogen.sh Automake done. Need to improve tests 2021-05-28 13:36:39 +02:00
ChangeLog Automake done. Need to improve tests 2021-05-28 13:36:39 +02:00
configure.ac more general HDF5 detection 2021-06-22 11:37:54 +02:00
COPYING Automake done. Need to improve tests 2021-05-28 13:36:39 +02:00
INSTALL Automake done. Need to improve tests 2021-05-28 13:36:39 +02:00
LICENSE Initial commit 2021-01-18 15:48:36 +01:00
Makefile.am add sections 2021-06-22 16:04:25 +02:00
NEWS Automake done. Need to improve tests 2021-05-28 13:36:39 +02:00
README Automake done. Need to improve tests 2021-05-28 13:36:39 +02:00
README.md add badges for the CI and the latest release 2021-06-16 14:04:10 +02:00
Sparse.org Moved sparse documentation in src/templates_front/templator_front.org 2021-06-03 13:56:45 +02:00
trex.org fix typos 2021-06-18 12:30:57 +02:00

README.md

build GitHub release (latest by date)

TREXIO

TREX library fo efficient I/O.

Minimal requirements (for users):

  • Autotools (autoconf, automake, libtool)
  • C compiler (gcc/icc/clang)
  • Fortran compiler (gfortran/ifort)
  • HDF5 library (>= 1.8)

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
  6. make check
  7. sudo make install

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

Additional requirements (for developers):

  • 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. ./autogen.sh
  4. TREXIO_DEVEL=1 ./configure
  5. make
  6. make check
  7. sudo make install

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.