This repository hosts the documentation website for FZ - Parametric Scientific Computing Framework.
Visit the live documentation at: https://funz.github.io/fz.github.io
Try FZ directly in your browser:
- FZ-Moret - Moret model plugin
- FZ-MCNP - Monte Carlo N-Particle Transport
- FZ-Cathare - Thermal-hydraulic system code
- FZ-Cristal - Cristal simulation plugin
- FZ-Scale - Scale nuclear analysis code
- FZ-Telemac - Hydrodynamics simulation system
This site is built with MkDocs and the Material theme.
pip install mkdocs mkdocs-material pymdown-extensions# Clone the repository
git clone https://github.com/Funz/fz.github.io.git
cd fz.github.io
# Serve locally with live reload
mkdocs serve
# Open http://127.0.0.1:8000 in your browser# Build static site
mkdocs build
# Output in site/ directoryThe documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch via GitHub Actions.
Contributions to the documentation are welcome! Please:
- Fork this repository
- Create a feature branch
- Make your changes
- Test locally with
mkdocs serve - Submit a pull request
- Documentation pages are in
docs/ - Notebooks are in
notebooks/ - Configuration is in
mkdocs.yml
BSD 3-Clause License - see the FZ repository for details.