FZ Documentation Website

This repository hosts the documentation website for FZ - Parametric Scientific Computing Framework.

📚 Documentation Site

Visit the live documentation at: https://funz.github.io/fz

🚀 Quick Links

• Installation Guide
• Quick Start
• Core Functions
• Plugins
• Google Colab Notebooks

📓 Google Colab Examples

Try FZ directly in your browser:

• Perfect Gas Example
• OpenModelica Integration

🔌 FZ Plugins

• 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

🛠️ Building the Documentation

This site is built with MkDocs and the Material theme.

Prerequisites

pip install mkdocs mkdocs-material pymdown-extensions

Local Development

# 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

# Build static site
mkdocs build

# Output in site/ directory

Deploy

The documentation is automatically deployed to GitHub Pages when changes are pushed to the main branch via GitHub Actions.

📝 Contributing

Contributions to the documentation are welcome! Please:

1. Fork this repository
2. Create a feature branch
3. Make your changes
4. Test locally with mkdocs serve
5. Submit a pull request

Adding Content

• Documentation pages are in docs/
• Notebooks are in notebooks/
• Configuration is in mkdocs.yml

📄 License

BSD 3-Clause License - see the FZ repository for details.