Welcome to the GENE-X Wiki!

“What and what not”

The Wiki provides advanced documentation that is not about the source code itself. This includes specific information, quality-of-life features, machine settings, and many more..

Hint

Alternative pages with information are

• The Gitlab pages that provide code-related documentation.

• The README that provides minimum-required information to do something with the code.

GENE-X community

Please consult our webpage contact form if any questions arise at any point.

We encourage you to subscribe to the genex-users mailing list which provides a platform to ask questions and to get the most recent code information.

If you would like to be part of specialized mailing lists or of the Slack channel, please consult the general genex mail address above to get more information.

Quick links

• Quickstart

• Automatic build with Confix

• Verifying the installation

• First steps

• Guide to simulation parameters

• Running on a cluster

• GENE-X QOL bash functions

• Setting up CI/CD and runners

Video tutorials

• User tutorial January 2026

FAQ

• I have a problem with the code, what should I do? (technical)

• My CI/CD runner has problems, what should I do? (technical)

Table of contents

• Technical documentation
  • Advanced build options
  • Build GENE X on machine without internet
  • GENE X Bash Functions
  • Known issues and fixes
  • SLURM gres option
  • Setting up CI/CD
• User guide
  • Automatic build with Confix
  • First steps
  • Quickstart instructions
  • Running on a cluster
  • Testing GENE-X
  • Guide to simulation parameters
• Video tutorials
  • Recordings of the user tutorial workshop, January 2026

Icons by Font Awesome, licensed CC BY 4.0.