Welcome to exax’s online documentation!

Contents:

• 1. What is Exax?
  • 1.1. Simplified Block Diagram
  • 1.2. Design Goals
  • 1.3. Some Key Highlights
• 2. Basic Terminology and Operation
  • 2.1. Block Diagram
  • 2.2. What is a Job?
  • 2.3. What is a Build Script?
  • 2.4. What is a Job Script?
  • 2.5. An Example
  • 2.6. A Few More…
• 3. High Level Example Project
  • 3.1. Example
• 4. Quickstart
  • 4.1. Install
  • 4.2. Get help
  • 4.3. Start a new project
  • 4.4. Start an exax server
  • 4.5. Access the exax Board web server
  • 4.6. Show available build scripts
  • 4.7. Run the Tutorial and Other Examples
  • 4.8. Show available method directories, job scripts and descriptions
  • 4.9. Run a specific build script
  • 4.10. Packages and Filename Prefixes
  • 4.11. The Configuration File
• 5. Job Fundamentals
• 6. Script Packages
  • 6.1. Method Packages and File Naming
  • 6.2. Enabling Method Directories in accelerator.conf
  • 6.3. Execution Restriction and Interpreter Selection
• 7. Build Scripts
  • 7.1. Build Scripts Create Jobs
  • 7.2. The Minimal Build Script
  • 7.3. Build Script Naming and Execution
  • 7.4. Building Job Scripts
• 8. Job scripts
  • 8.1. Building Job Scripts
  • 8.2. Existing Jobs Will be Re-Used Whenever Possible
  • 8.3. Passing Input Parameters
  • 8.4. Receiving Input Parameters
  • 8.5. Options: Default Values and Typing
  • 8.6. Execution and Data Flow
  • 8.7. Share Data using Return Value
  • 8.8. Writing Files
  • 8.9. Registering Files
  • 8.10. Find and Load Created Files
  • 8.11. Reading Input Files
  • 8.12. Adding a Description
  • 8.13. Retrieving stdout and stderr
  • 8.14. Progress/status reporting
  • 8.15. Subjobs
• 9. Advanced Script Features
  • 9.1. Depend on extra files
  • 9.2. Equivalent Hashes
  • 9.3. Accessing a Job’s parameters
  • 9.4. Accessing a Job’s post data
  • 9.5. Creating Custom Status Messages
  • 9.6. Limiting Concurrency
  • 9.7. Automatic Slice-Data Merging: merge_auto
  • 9.8. Forced Builds
• 10. More on Option Typing
  • 10.1. Additional Option Types
  • 10.2. Typing Examples
  • 10.3. Option Typing Formal Rules
• 11. All About Files
  • 11.1. Writing and Reading data
  • 11.2. Registering files
  • 11.3. Sliced Files
  • 11.4. Temporary Files
  • 11.5. Input Files
• 12. Urd Database - Introduction
  • 12.1. What is Stored in the Urd Database?
  • 12.2. How is Data Stored?
  • 12.3. The Automatic Urd List
  • 12.4. Initiating a manual Urd session
  • 12.5. Ending a Manual Urd Session
  • 12.6. Collisions and Updates
  • 12.7. Urd Database Timestamps
  • 12.8. Truncating Urd Lists
• 13. Urd Database - Retrieval
  • 13.1. Retrieving Sessions from the Database
  • 13.2. Retrieving a Session and make it a Dependency
  • 13.3. Retrieving a Session with no Dependency
  • 13.4. Description of the Retrieval Functions
  • 13.5. Finding Recent Timestamps
  • 13.6. Working with JobLists
• 14. Urd Database - The Admin
  • 14.1. Setup a shared server
  • 14.2. Connecting to a Shared Urd Server
  • 14.3. Directory Structure of the Urd Database
• 15. The configuration file
  • 15.1. The configurable parameters
• 16. Troubleshooting, Trix and Tips
  • 16.1. The exax server fails to start
  • 16.2. Urd conflict Error
  • 16.3. The build creates a new job although it already exists
  • 16.4. Remove items from the Urd database
  • 16.5. Connecting to a remote board server
  • 16.6. What’s the thing with -LATEST?
  • 16.7. Urd view in board does not show correct link_results
  • 16.8. How to abort a running job
  • 16.9. Connect to a remote
  • 16.10. Setting up a remote urd or board server
• 17. Autodoc Job Classes
  • Job
  • CurrentJob
• 18. Autodoc Dataset Classes
  • Dataset
  • DatasetWriter
  • DatasetList
  • DatasetChain
• 19. Autodoc Urd Classes
  • Urd
  • JobList
• 20. Autodoc Misc
  • JobWithFile
  • DotDict
  • Colour

Indices and tables

• Index

• Search Page