TREX/trexio
1
0
Fork 0
mirror of https://github.com/TREX-CoE/trexio.git synced 2024-12-23 04:43:57 +01:00
Code Issues Projects Releases Wiki Activity

added minimal requirements

Browse Source
This commit is contained in:
q-posev 2021-05-03 15:58:01 +02:00
parent 006a9644d2
commit f42dccc5b9
1 changed files with 38 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -2,36 +2,59 @@
TREX library fo efficient I/O.
## Current installation procedure from the tarball (`trexio-<version>.tar.gz`):
1. `gzip -cd trexio-<version>.tar.gz | tar xvf -`
2. `cd trexio-<version>`
3. `./configure`
4. `make && sudo make install`
5. `make check`
## Minimal requirements (for users):
## Current (temporary) installation procedure from the GitHub repo clone:
- 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`
4. `cd tools && ./build_trexio.sh && cd ..`
5. `autoreconf`
6. `automake --add-missing --copy`
7. `./configure`
8. `make && sudo make install`
9. `make check`
3. `cd tools && ./build_trexio.sh && cd ..`
4. `autoreconf`
5. `automake --add-missing --copy`
6. `./configure`
7. `make && sudo make install`
8. `make check`
**Note: on systems with no `sudo` access, one can replace `./configure` with `./configure prefix=${PWD}` in order to execite `make install/uninstall` commands with `sudo` rights. This will enable the installation in the root directory of the library.**
## Tutorial
**TODO**
## Technical documentation
[Generated from TREXIO org-mode files](https://trex-coe.github.io/trexio/)
[Documentation generated from TREXIO org-mode files](https://trex-coe.github.io/trexio/)
### Miscellaneous
Note: The code should be compliant with the C99 [CERT C coding
standard](https://resources.sei.cmu.edu/downloads/secure-coding/assets/sei-cert-c-coding-standard-2016-v01.pdf). This can be checked with the `cppcheck` tool.