General Overview

Welcome to the TRACE Modeling Guidelines general resources section.

About These Guidelines

These guidelines represent best practices and lessons learned from years of TRACE modeling experience across various reactor types and applications.

Contributing

We welcome contributions! This is an internal repository: changes are made on a branch here and merged through a pull request. Do not fork — a pull request from a fork cannot be merged. In outline:

1. Ask a maintainer for write access, then clone the repository
2. Create a feature branch
3. Make your changes in the appropriate section
4. Preview locally with mkdocs serve
5. Sync your branch with the latest main and resolve any conflicts
6. Push the branch and open a pull request (or open an issue for small corrections)

See Contributing for the full workflow, including the commit hooks you must install first. We use small, focused pull requests and coordinate if multiple people are editing the same page.

License

This documentation is provided under the MIT License.