Skip to content

Module Contributor Documentation

This is the landing page for resources related to contributing a module to the FACTS2 ecosystem.

Contents

  • Module Contributor Guide: Start here! An overview of all of the steps required to develop a module for FACTS.
  • FACTS Module Requirements: This page details all of the requirements that a module must satisfy to be added to the FACTS2 framework.
  • Building a FACTS module tutorial: A step-by-step tutorial showing how to build a module that can be run within the FACTS framework.
  • Submitting a module to the FACTS framework tutorial: Instructions for adding a new module to the FACTS framework, includes a section on writing a module yaml and submitting an entry to the module registry.
  • FACTS Output Types: Overview of the objects written at each step of a FACTS experiment.