starter-kit/README.md

69 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2025-09-22 14:54:12 -04:00
# Nuclear Reactor Starter Kit
The Nuclear Reactor Starter Kit (NRSK) is a set of requirements, procedures,
processes, templates, checklists, and data intended as a starting point for
a commercial nuclear reactor development and/or deployment program. The
objective of the NRSK is to speed up nuclear reactor deployment worldwide. Its
approach for doing so includes:
1. To identify and document modern best practices for achieving compliance and efficiency
2. To allow the nuclear industry to collaborate and share
3. To help newcomers to the field ramp up quickly
All commercial nuclear reactor and fuel processing facilities and their suppliers are
required by law to follow a set of rigorous regulations. Doing so doesn't need to be
debilitating.
The NRSK began as USA-centric in that it started with fundamental quality requirements
from 10 CFR 50 Appendix B and traced down uniformly to specific procedure sections and
other needs. However, given some homogeneity in nuclear quality regulatory regimes
worldwide, it is expected that this will be readily adaptable to other jurisdictions as
well.
## Features
- Scrape GDCs from 10 CFR 50 App A into individual requirements
- Scrape each 'shall' statement from 10 CFR 50 App B into individual
requirements to drive a traceable QA procedure set
- Provide procedures implementing the requirements
- Each section of each procedure explicitly tied to a basis explaining why it is
the way it is (flowed down from regulatory requirements or elsewhere)
- Provide fillable forms and checklists to document progress and compliance
- Fillable by human and/or computer (e.g. e-forms)
## Installing
### Install prerequisites
- python
- xelatex
### Install NSRK
1. Make a virtual environment:
python3 -m venv /path/to/venv
source /path/to/venv/bin/activate
2. Clone repo:
git clone /path/to/nrsk
3. Install dependencies:
pip install -e .[dev]
## Building initial documents
Generate the baseline data files:
python src/nsrk/regs/load_10cfr50.py
Build docs via Sphinx using::
cd documents
make html
make latex
cd build/latex
for f in *.tex; do xelatex $f; done