Skip to main content
Ctrl+K
bloc 0.1.dev1+ga5c71cb83 documentation - Home bloc 0.1.dev1+ga5c71cb83 documentation - Home
  • Minimum Working YAML
  • Bloc CLI reference
  • Reactor Types
  • Migration Guide: ctwrap → STONE
  • Unit Conventions
    • Calculation Note — Reporting Contract
    • Note Formats in YAML Configuration Files
    • Examples
    • API Reference
  • Minimum Working YAML
  • Bloc CLI reference
  • Reactor Types
  • Migration Guide: ctwrap → STONE
  • Unit Conventions
  • Calculation Note — Reporting Contract
  • Note Formats in YAML Configuration Files
  • Examples
  • API Reference

Welcome to Bloc’s documentation!#

Bloc Diagram Simulation of Spark Thermochemical Processes.

image

STONE YAML syntax is specified by Boulder. Use Boulder’s STONE_SPECIFICATIONS.md as the source of truth for the schema; these docs focus on Bloc-specific reactors, CLI usage, units, and Calculation Notes.

Contents:

  • Minimum Working YAML
    • Tube furnace (DesignTubeFurnace)
    • SPRING (torch → PSR → PFR chain)
    • Running the YAML
  • Bloc CLI reference
    • Common commands
    • Migration helper commands (Boulder)
    • Why use bloc instead of boulder?
    • Notes
  • Reactor Types
    • Architecture overview
    • Why not Cantera’s FlowReactor?
    • Numerical engines
    • Industrial Models
    • Kind rename map
    • PFRNetwork — Unified network driver
  • Migration Guide: ctwrap → STONE
    • High-level mapping
    • Key-by-key changes
    • What to do with _old.yaml files
  • Unit Conventions
    • Thermodynamic quantities
    • Flow quantities
    • Composition
    • Molecular weight
    • Geometry
    • Energy
    • PFR thermal hypotheses
    • Time
  • Calculation Note — Reporting Contract
    • export: block reference
    • How kpi_fn is resolved
    • Figure generators
    • Excel workbook structure
    • Generating the Calculation Note
    • See also
  • Note Formats in YAML Configuration Files
    • Overview
    • Supported Note Formats
    • Real-World Examples
    • Important Notes
    • Integration with Calculation Notes
    • Best Practices
    • Example: Complete YAML with Notes
    • See Also
  • Examples
  • API Reference
    • Submodules

Indices and tables#

  • Index

  • Module Index

  • Search Page

next

Minimum Working YAML

On this page
  • Welcome to Bloc’s documentation!
  • Indices and tables

© Copyright 2024, Copyright (C) Spark Cleantech SAS (SIREN 909736068).

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.18.0.