BCI Research Software Engineering Guide

Contents:

• RSE Best Practices
  • Write code for readability, maintainability, and clarity
    • Whitespace and parentheses
    • Comments
    • Docstrings
    • Miscellaneous
  • Write small functions that do one thing, and do that one thing well
    • Benefits
  • Don’t assume your code does what you think - test it.
    • Make validation and tests easy to run
    • Test small bits of code at a time
    • Use test frameworks to simplify the process
    • Compiled code
    • Other benefits of testing
  • Help other users and developers with good documentation
    • READMEs
    • User Documentation
  • IDEs and automatic tools
    • Syntax Highlighting and Linting
    • Auto completion (Intellisense), Snippets, and Auto Documentation
    • Keyboard shortcuts
    • Debugging
  • Version Control
    • Versioning (Version numbering)
    • Version Control (Git)
  • Language Specific Styles
    • Python
    • MATLAB
    • Fortran
    • C++
• Abaqus User Subroutines
  • Fortran Guidelines
    • Visual Layout
    • Style
    • Numerical
    • Program Units
    • Checking Code Correctness
    • Banned Features
  • Using Fortran Modules
    • About Fortran Modules
    • Modularising your User Subroutine
    • Running Abaqus with Modular Code
    • Generating a Single-Source Version
  • Free-form Fortran with Abaqus
    • Free form vs. Fixed-form
    • Using Free-form with Abaqus
  • Explicit Typing with Abaqus
    • Implicit Typing
    • Explicit Typing
    • Explicit Typing with Abaqus
  • Using Named State Variables
    • Motivation
    • Using Named State Pointer Variables
    • Organising State Pointers into a Type (structure)
  • Reading Material Properties from a Namelist File
    • Motivation
    • The Fortran NameList Format
    • Reading a NameList file in Fortran
    • Error Detection
    • Using NameList Files for User Subroutines
    • Advanced: NameLists with Derived Types (Structures)
  • Using Abaqus on UoB HPC clusters
    • Setup
    • Fair Use
    • Running Jobs
    • User Guides
• RSE Guides
  • Getting started with Git
    • Getting started
    • Next Steps
    • Support
  • Installing Abaqus on your University of Bristol (UoB) machine
    • Getting started