Commit ba242df2 authored by liang's avatar liang
Browse files

Add installation details to ESCDF module

parent 1a5fcfaa
......@@ -15,6 +15,13 @@
import sys
import os
import subprocess
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:'cd ../doxygen; doxygen', shell=True)
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
......@@ -38,6 +38,7 @@ The first Electronic Structure ESDW in Zaragoza in June 2016 was the starting po
Contributing to this documentation
.. _example:
.. sidebar:: Software Technical Information
C with Fortran 2003 bindings.
Documentation Tool
Application Documentation
`ESL wiki <>`_
L-GPL v3
.. contents:: :local:
Libescdf is a library containing tools for reading and writing massive
data structures related to electronic structure calculations,
following the standards defined in the `Electronic Structure Common
Data Format
Purpose of Module
Libescdf is a library created to exchange electronic-structure-related
data in a platform-independent and efficient manner. It is based on
the Electronic Structure Common Data Format Specifications, as well as
Software Technical Information
L-GPL v3
C with Fortran 2003 bindings.
Documentation Tool
Application Documentation
`ESL wiki <>`_
A release can be download from `HERE <>`_
Current installation and testing are done with gcc compiler. HDF5 is required for instalation and testing.
Here are the commands for instalation::
$ tar xfvz libescdf-0.1.0.tar.gz
$ ./configure
$ make
.. note ::
We provide also the possibility to build modules with Autotools. `Here <>`_ are some userful documents.
Libescdf contains several unit tests that can be used to check the
compilation and to perform regression testing. These tests can be
executed by doing:
$ make check
Source Code
The source code is available from the `E-CAM Gitlab`__ under the `escdf`__
project. The Libescdf directory can be found `here`__.
.. __:
.. __:
.. __:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment