Comfor Documentation

Comfor (COMfor FORming) is a high-performance open-source software for composite material simulation. It is designed to provide researchers, engineers, and students with a robust tool for simulating composite materials efficiently.

This documentation covers installation, usage, and advanced features to help you get the most out of Comfor.

Table of Contents

• Introduction
• Getting Started
  • Install Dependencies
  • Build Documentation
  • Serve Locally
• Resources
• License

Introduction

Comfor provides a reliable and high-performance environment for composite material simulations.

Key features:

• Fast and robust simulation engine
• Open-source and customizable
• Documentation with examples for beginners and experts

Getting Started

Install Dependencies

Create a Python virtual environment and install required packages:

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r requirements.txt

Or use the Makefile:

make install

Build Documentation

To generate the static documentation site, use the following commands:

make build

For language-specific builds:

make build-en   # Build English documentation
make build-fr   # Build French documentation

Note: The generated site will be available in the public/ directory.

Serve Locally

To preview the documentation, run:

make serve

For language-specific previews with live reloading:

make serve-en   # Serve English documentation
make serve-fr   # Serve French documentation

Visit http://127.0.0.1:8000/comfor-doc/en/ to see the site locally.

Note: The URL path (/en or /fr) depends on the language you are serving.

Resources

• Material for MkDocs theme
• MkDocs official documentation
• Comfor repository

License

Comfor Documentation by Eduardo Guzman is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.
Based on a work at https://gitlab.com/comfor/comfor-doc.