Difference between revisions of "Get Xdmf"

From XdmfWeb
Jump to navigationJump to search
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The old version of this page can be found at [http://xdmf.org/index.php/Get_Xdmf_original]
+
The old version of this page can be found [http://xdmf.org/index.php/Get_Xdmf_original here.]
  
Xdmf depends on zlib and hdf5 and had a header only dependency on boost. You must obtain and build those projects before you can build xdmf.
+
Xdmf depends on [https://www.hdfgroup.org/HDF5/ HDF5] and has a header only dependency on [http://www.boost.org/ Boost]. You must obtain and build those projects before you can build Xdmf. You will need [https://cmake.org/ CMake] to build Xdmf from source code. To use Xdmf from Python or Java you will also need [http://www.swig.org/ Swig].
To use Xdmf from Python, Tcl or Java you will also need swig.
 
  
To obtain xdmf:
+
Xdmf development is now being hosted at Kitware's gitlab at: https://gitlab.kitware.com/xdmf/xdmf.
* git clone git://public.kitware.com/Xdmf.git XDMF
+
See [http://www.kitware.com/pipermail/xdmf/2016-April/000935.html this] post for additional details.  
* mkdir build
 
* cd build
 
* ccmake ..
 
* make
 
  
To use xdmf from wrapped languages you will need to configure XDMF_WRAP_PYTHON, or XDMF_WRAP_JAVA on in ccmake.
+
Use the following procedure and commands to download, build, and install Xdmf. These instructions assume that the environment variable <code>XDMF_INSTALL_DIR</code> contains the path where you want to install Xdmf.
  
Xdmf is also mirrored in VTK. To use XDMF within VTK, simply turn on Module_vtkIOXdmf2 or Module_vtkIOXdmf3 on the advanced options page of you VTK configuration.
+
* Clone the Git repository:
 +
<source lang="bash">
 +
git clone git://xdmf.org/Xdmf.git
 +
</source>
 +
or,
 +
<source lang="bash">
 +
git clone https://gitlab.kitware.com/xdmf/xdmf.git
 +
</source>
 +
* Create and enter the directory for building the code:
 +
<source lang="bash">
 +
cd Xdmf
 +
mkdir build
 +
cd build
 +
</source>
 +
* Prepare the CMake-based build. There are two options
 +
*# Use the following command and select options using a text-based menu system:<source lang="bash">ccmake ..</source>
 +
*# If you are familiar with CMake, you may set various configuration options on the command line. For example, a typical command line for building Xdmf with Python bindings may look like the following:
 +
  <source lang="bash">
 +
  export XDMF_INSTALL_DIR=/opt/Xdmf/
 +
  cmake .. -DCMAKE_INSTALL_PREFIX=${XDMF_INSTALL_DIR} \
 +
            -DBUILD_SHARED_LIBS=1 -DXDMF_WRAP_PYTHON=1 -Wno-dev
 +
  </source>
 +
* Make and install Xdmf:
 +
<source lang="bash">
 +
make
 +
make install
 +
</source>
 +
 
 +
 
 +
To use xdmf from wrapped languages you will need to configure <code>XDMF_WRAP_PYTHON</code>, or <code>XDMF_WRAP_JAVA</code> on in ccmake.
 +
 
 +
Xdmf is mirrored in VTK which has reader and writer classes the call into XDMF to do file IO. To use XDMF within VTK, simply turn on <code>Module_vtkIOXdmf2</code> or <code>Module_vtkIOXdmf3</code> on the advanced options page of you VTK configuration.

Latest revision as of 14:16, 13 March 2017

The old version of this page can be found here.

Xdmf depends on HDF5 and has a header only dependency on Boost. You must obtain and build those projects before you can build Xdmf. You will need CMake to build Xdmf from source code. To use Xdmf from Python or Java you will also need Swig.

Xdmf development is now being hosted at Kitware's gitlab at: https://gitlab.kitware.com/xdmf/xdmf. See this post for additional details.

Use the following procedure and commands to download, build, and install Xdmf. These instructions assume that the environment variable XDMF_INSTALL_DIR contains the path where you want to install Xdmf.

  • Clone the Git repository:

<source lang="bash"> git clone git://xdmf.org/Xdmf.git </source> or, <source lang="bash"> git clone https://gitlab.kitware.com/xdmf/xdmf.git </source>

  • Create and enter the directory for building the code:

<source lang="bash"> cd Xdmf mkdir build cd build </source>

  • Prepare the CMake-based build. There are two options
    1. Use the following command and select options using a text-based menu system:<source lang="bash">ccmake ..</source>
    2. If you are familiar with CMake, you may set various configuration options on the command line. For example, a typical command line for building Xdmf with Python bindings may look like the following:
  <source lang="bash">
  export XDMF_INSTALL_DIR=/opt/Xdmf/
  cmake .. -DCMAKE_INSTALL_PREFIX=${XDMF_INSTALL_DIR} \
           -DBUILD_SHARED_LIBS=1 -DXDMF_WRAP_PYTHON=1 -Wno-dev
  </source>
  • Make and install Xdmf:

<source lang="bash"> make make install </source>


To use xdmf from wrapped languages you will need to configure XDMF_WRAP_PYTHON, or XDMF_WRAP_JAVA on in ccmake.

Xdmf is mirrored in VTK which has reader and writer classes the call into XDMF to do file IO. To use XDMF within VTK, simply turn on Module_vtkIOXdmf2 or Module_vtkIOXdmf3 on the advanced options page of you VTK configuration.