UCIS4EQ: Technical Documentation for an HPC-Based Microservice Framework for Earthquake Simulation

This publication provides the technical documentation for UCIS4EQ, a computational framework designed to support rapid earthquake simulation workflows using high-performance computing (HPC) infrastructures and microservice-based architectures. The document describes the overall architecture and operational workflow of UCIS4EQ, explaining how the system integrates distributed services, scientific codes, and data repositories to perform large-scale earthquake simulations and scenario analyses. It details the internal organization of the UCIS4EQ ecosystem, including the structure of the GitLab repository, the HPC data repository, and the HPC-site deployment environment. A significant part of the documentation is dedicated to developer guidelines. These sections explain how to extend the platform by adding new geographical regions, integrating new microservices, configuring additional HPC machines, and preparing new simulation use cases. Practical instructions are provided for generating required input data (such as meshes and velocity models), integrating them into the system, and managing containerized services. The document also includes installation and deployment instructions, covering system dependencies, service configuration, deployment on new machines, and execution of existing use cases. Guidance is provided for running simulations and interacting with the monitoring dashboard. This documentation is intended for researchers, developers, and system administrators who need to deploy, maintain, or extend the UCIS4EQ framework within HPC environments.