Contributing

• Code style
  • Introduction
  • Naming Conventions
    • File Names
    • Function Names
    • Variable Names
    • Member Names
    • Class/Struct Names
    • Alias/Typedef Names
    • Namespace Names
    • Example
  • Const Keyword
  • Code Format
  • Header Guards
• Git Workflow
  • Git Credentials
  • Downloading the Code
  • Branching Model
    • Feature Branches
    • Bugfix Branches
    • Release Candidate Branches
    • Hotfix Branches
    • Documentation Branches
  • 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
    • Build locally
    • On readthedocs
  • Guidelines
    • What to document
    • How to document
  • Example
  • Current Doxygen
• Unit Testing
  • GEOS Specific Recommendations
  • MPI
• Contributing Input Files
• Integrated Tests
  • About
  • Structure
  • How to Run the Tests
    • GEOS CI Pipeline
    • Manual Test Runs
    • Override Test Behavior
    • Machine Definitions
    • Test Filtering
  • Inspecting Test Results
    • Test Output
  • Restart Check
    • Scalar Error Example
    • Array Error Example
    • The .diff.hdf5 File
  • Curve Check
    • Item Not Found Errors
  • Adding and Modifying Tests
    • ATS Configuration File
    • Creating a New Test Directory
  • Rebaselining Tests
  • Tips
• Benchmarks
  • Running the benchmarks
  • Specifying a benchmark
    • The Run block
  • 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