US3D Installation

US3D Installation


The US3D distribution package that you downloaded is encrypted to protect it from unauthorized distribution. The following steps will get you started with decrypting, uncompressing, and compiling the code.

Uncompressing the package

First uncompress the distribution package with a command like:

tar -zxf US3D-<version>-package.tar.gz

cd US3D-<version>-package

Decrypting the US3D distribution

The US3D distribution has been encrypted using PGP and the US3D public encryption key which you should have already received. To recap, you first need to add the US3D private encryption key to your keychain. To do this, first decrypt and import the private key:

gpg -o - -d US3D-*-privkey*.asc | gpg --import

Decrypt the US3D distribution using the US3D private key which you already imported into your GPG keyring when you followed the US3D User Distribution Notes and pipe the decrypted output to tar:

gpg -d US3D-<version>.tar.gz.gpg | tar -zx

Verify the digital signature (optional)

To verify the digital signature for the source code tar file, you can use this GPG command:

gpg --verify US3D-<version>.tar.gz.sig \



Basic installation instructions are in the README.txt file contained there. For more details, please see the US3D manual found in the docs directory. The short version is:

cd US3D-<version>


License File

This version of US3D requires a license file to function.  See the License FIle pages for more information.


After you've successfully installed US3D, you can use the us3d-module file to integrate with your system environment modules. Or, you can run US3D by specifying the full path to the executables in the bin/ directory. Documentation and examples can also be found in the installation directory to help you get started.

US3D Module

It is best to keep track of the versions of US3D that you install and to label them with the GCC and OpenMPI version for that package. For example, assuming that you have downloaded the US3D package for GCC-5.2 and OpenMPI 3.1, then you might install it into the directory:


After installation, link the provided US3D module into your modules system:

mkdir -p /software/us3d/1.1.1/gcc/5,2/openmpi
cd /software/us3d/1.1.1/gcc/5,2/openmpi
ln -s /software/us3d/1.1.1/gcc/5,2/openmpi/3.1/us3d-module 3.1

Then when you type module avail you should see your US3D module listed, and the path to the module will reflect the compatible GCC and OpenMPI modules that you also need to load. If you wish, you can add module prereq lines into the US3D module file. For example, you could add:

prereq compilers/gcc/5.2.0
prereq openmpi/3.1.0/gcc/5.2.0

to ensure that the proper modules have been loaded.