SEACAS [Documentation]
- Get the sources
- Build instructions
- Configure, Build, and Install SEACAS
- Testing
- Exodus
- License
- Ubuntu
- Contact information
- For information on building with MPI, see README-PARALLEL.md
- NOTE: The old imake-based build has been removed.
git clone https://github.com/gsjaardema/seacas.git
This will create a directory that will be referred to as seacas in the instructions that follow. You can rename this directory to any other name you desire. Set an environment variable pointing to this location by doing:
cd seacas && export ACCESS=`pwd`
There are a few externally developed third-party libraries (TPL) that are required to build SEACAS.
- Zoltan -- required, supplied
- HDF5 -- optional
- NetCDF -- required with modifications
- MatIO -- optional
- GNU Parallel -- optional
- CGNS -- experimental optional
A snapshot of zoltan_distrib_v3.83.tar.gz is provided in seacas/packages/zoltan. This will be built automatically as part of the SEACAS build process.
If you are using the netcdf-4 capability in the netcdf library or are using the MatIO library for conversion of exodus to/from matlab format, then you will need the hdf5 library.
The hdf5 library is used for the netcdf4 capability in netcdf which in turn is used by exodus. The netcdf4 capability is typically used for large models (>150 million elements); if you are not planning to create or read models of this size, you do not have to build hdf5.
- Download HDF5 from http://www.hdfgroup.org/HDF5/release/obtain5.html and put it inside
seacas/TPL/hdf5
- untar it
cd
to that directory and enter the command:sh ../runconfigure.sh
make && make install
The most recent released version is recommended. For use with Exodus, some local modifications to the netcdf.h include file are required. See NetCDF-Mapping.md for an explanation of why these modifications are required (or highly recommended)
-
Download the latest netcdf-c release from http://www.unidata.ucar.edu/downloads/netcdf/index.jsp and put it inside
seacas/TPL/netcdf
-
cd TPL/netcdf
-
tar zxvf netcdf-4.4.1.1.tar.gz
-
Modify the following defines in seacas/TPL/netcdf/netcdf-4.4.1.1/include/netcdf.h.
#define NC_MAX_DIMS 65536 /* max dimensions per file */ #define NC_MAX_VARS 524288 /* max variables per file */
-
If you did not build HDF5, then you will need to edit the runcmake.sh script and remove all lines mentioning HDF5 and also set
ENABLE_NETCDF_4
toOFF
-
cd netcdf-4.4.1.1
and enter the command:mkdir build cd build sh ../../runcmake.sh
-
make && make install
The MatIO library is used in the exo2mat and mat2exo programs which convert an exodus file to and from a MATLAB binary file. To use this do:
-
Download matio via git:
-
cd TPL/matio
-
git clone https://github.com/tbeu/matio.git
-
cd matio
and enter the command:./autogen.sh sh ../runconfigure.sh
-
make && make install
GNU Parallel is a shell tool for executing jobs in parallel using one or more computers. A job is typically a single command or a small script that has to be run for each of the lines in the input. The typical input is a list of files, a list of hosts, a list of users, or a list of tables. In SEACAS, this is only used by epup which runs multiple epu jobs concurrently. To build:
-
Download the most recent version of the library from ftp://ftp.gnu.org/gnu/parallel/parallel-latest.tar.bz2.
cd TPL/parallel tar jxvf /path/to/parallel-latest.tar.bz2 cd parallel-20150522 sh ../runconfigure.sh
-
make && make install
Experimental support for CGNS in the IOSS library is being added. To use this capability, you will need to download and install the CGNS library:
- Download CGNS via git:
```
cd TPL/cgns
git clone https://github.com/CGNS/CGNS.git
```
- Build using CMake.
- Modify
TPL/cgns/runconfigure.sh
to meet your environment cd CGNS
mkdir build
cd build
../../runconfigure.sh
make && make install
- Modify
At this time, you should have all external TPL libraries built and
installed into ${ACCESS}/lib
and ${ACCESS}/include
. You are now ready
to configure the SEACAS CMake build.
cd $ACCESS
mkdir build
cd build
- edit the
${ACCESS}cmake-config
file and adjust compilers and other settings as needed. - enter the command
../cmake-config
and cmake should configure everything for the build. make && make install
- If everything works, your applications should be in
${ACCESS}/bin
There are a few unit tests for zoltan, exodus, and aprepro that can be run via make test
if you configured with -D SEACASProj_ENABLE_TESTS=ON
.
There is also a system-level test that just verifies that the applications can read and write exodus files correctly. This test runs off of the installed applications. To run do:
make install
cd ../SEACAS-Test
make clean; make
This will run through several of the SEACAS applications creating a mesh (exodus file) and then performing various manipulations on the mesh. If the test runs successfully, there is some hope that everything has built and is running correctly.
If you only want the exodus library, then follow most of the above instructions with the following exceptions:
- You can either clone entire source tree as above, or you can download a zip file containing only the exodus source (and build-related files). The url for the zip file is https://github.com/gsjaardema/seacas/archive/exodus.zip.
- You only need the netcdf and optionally hdf5 libraries
- Use the
cmake-exodus
file instead ofcmake-config
. - This will build, by default, a shared exodus library and also install the exodus.py Python interface.
SEACAS is licensed under the Modified BSD License. See the LICENSE file for details.
There is a PPA available for SEACAS that is updated nightly from SEACAS master
. Anyone using Ubuntu can now just add the PPA and do
sudo add-apt-repository ppa:nschloe/seacas-nightly
sudo apt-get update
and then
sudo apt-get install seacas-bin
to get the SEACAS binaries. You can also install 'libseacas-dev' or 'libseacas0'. This is provided by Nico Schlömer.
Greg Sjaardema (gsjaardema@gmail.com, gdsjaar@sandia.gov)