Developer Guide

Welcome to the GEOS developer guide. This guide serves as a reference for developers contributing to the GEOS project. The Contributing section provides general details and guidelines for contributing to the GEOS project. The Code Components section provides an overview of the some basic components that of the GEOS project.

• Contributing
  • Code style
    • Introduction
    • Naming Conventions
    • Const Keyword
    • Code Format
    • Header Guards
  • Git Workflow
    • Git Credentials
    • Downloading the Code
    • Branching Model
    • Keeping Your Branch Current
    • Branching off of a Branch
    • Submitting a Pull Request
    • Keeping Submodules Current
    • Working on the Submodules
    • Resolving Submodule Changes in Primary Branch PRs
  • Sphinx Documentation
    • Generating the documentation
    • Documenting the code
    • Fixing errors the documentation
  • Doxygen Documentation
    • Accessing
    • Guidelines
    • Example
    • Current Doxygen
  • Unit Testing
    • GEOS Specific Recommendations
    • MPI
  • Contributing Input Files
  • Integrated Tests
    • About
    • Structure
    • How to Run the Tests
    • Inspecting Test Results
    • Restart Check
    • Curve Check
    • Adding and Modifying Tests
    • Rebaselining Tests
    • Tips
  • Benchmarks
    • Running the benchmarks
    • Specifying a benchmark
    • Adding a benchmark problem
    • Viewing the results
  • Basic profiling with CALIPER
    • GEOS/Caliper Annotation Macros
    • Configuring Caliper
    • Using Adiak
    • Using Spot
    • Opening Spot caliper files in Python
  • [Best effort] Developing inside Docker with precompiled TPL binaries
  • [Best effort] Installing GEOS on Windows machines using Docker
    • 1. Install Docker Desktop
    • 2. Start Docker Desktop
    • 3. Preparing DockerFile
    • 4. Build the image and run the container
    • 5. Running a case
  • How to work interactively on the CI Machines
    • Step 1: Adding a GHA to establish a connection
    • Step 2: Inspect the CI and grab server address
    • Step 3: Connect to the machine via ssh
    • Step 4: Run the docker container interactively
    • Step 5: Cancel the workflow
• Code Components
  • Data Repository
    • Group
    • Wrapper
    • ObjectCatalog
    • Mapped Vector
    • Log levels documentation
  • XML Input
    • GEOS data structure overview
    • Example: adding a new relative permeability model
    • Input Schema Generation
  • Working with data in GEOS
    • Working with data on the Mesh objects
  • Mesh Hierarchy
    • DomainPartition
    • MeshBody
    • MeshLevel
    • Topological Mesh Objects
  • DoF Manager
    • Brief description
    • Methods
    • Example
    • Real mesh and patterns
  • LvArray
    • Use in GEOS
    • LvArray documentation
  • Kernel interface
    • Finite Element Method Kernel Interface
  • Constitutive models
    • Standalone models
    • Compound models
  • PVT Package Hierarchy
  • Adding a new Physics Solver
    • LaplaceFEM overview
    • Start doing your own Physic solver
    • Last steps