This repository contains the design documentation of FORM, documentation for performance and hardware acceleration, and supporting tools for the project.
The FORM design documentation is written using Sphinx and organized to support a structured software architecture report, including system overview, architectural design, and implementation considerations.
.
├── README.md # Project overview (this file)
├── doc/ # Main documention directory
└── tools/ # Example environment setup and helper scripts for sphinx
Contains the accelerator documentation and the Sphinx documentation project for FORM Design.
Contains environment configuration and setup scripts for Sphinx documentation.
environment.yml– Conda environment specificationsetup_sphinxdocs-env.sh– environment setup script- See
tools/README.mdfor details.