Abaci User Documentation

Abaci is a command line tool for streamlining the development, debugging and testing of Abaqus user subroutines.

Why use Abaci?

The primary advantage of using Abaci to develop Abaqus user subroutines, is the built-in debug mode which compiles your code with extra compile-time and runtime checks enabled. These checks will identify memory errors and undefined behaviour that would otherwise go unnoticed.

Abaci also automates and streamlines many processes involved in code development, including:

• Code compilation under different compiler flags and on different platforms

• Setup and organisation of job file directories

• Writing and running Fortran unit tests

• Running regression checks on output databases

• Running post-processing scripts after jobs have finished

• Compilation and linking of C and C++ source files

• Preparation and submission of SLURM cluster job scripts

• Reuse common code from other Abaci projects as dependencies

Getting Started

Prerequisites: Abaci requires the following software to be installed:

• Abaqus

• Intel Fortran Compiler

See the installation guide for instructions on how to download and install Abaci.

Once you have installed Abaci, consider reading the Quickstart Tutorial and the How-to guides.

Documentation and Support

You can find more detailed documentation in the Command Line Interface Reference and the Configuration File Reference.

If you encounter an problem using Abaci and cannot find the answer using the documentation, then feel free to open an issue in the Github repository.

Contents:

• Quickstart Tutorial
  • Introduction
  • Setup
  • Compiling User Subroutine Code
  • Running an Abaqus Job
  • The Configuration File
  • Next Steps
• How-to guides
  • How to Install/Update Abaci
  • Getting Started with Abaci in your Project
  • How to Setup Regression Checks
  • How to Setup Post-Processing Commands
  • How-to Write Unit Tests with Abaci
  • How to Generate Precompiled Binary Releases
  • How to Include C/C++ Sources
  • How to Submit Abaci Jobs to a SLURM Cluster
  • How to Reuse Code from other Abaci Projects
• Reference
  • Command Line Interface Reference
  • Configuration Reference
• Developer Notes
  • Implementation Language
  • Repository Structure
  • Creating a new release
  • Contents of a job folder
  • Contents of the lib folder