IDR-IIsim: Software Documentation

IDR-IISIM is an open-source compiler designed to process industrial models described in YAML format and generate Python scripts that can be integrated into large-scale energy system models and circular economy assessments.

This repository provides a reproducible and modular framework for describing industrial processes as data models, validating them, and generating executable scripts.

License

This project is licensed under the MIT License. You are free to use, modify, and distribute this software under the terms of the MIT license.

Contents

• Model Aim and Value Proposition
  • Why use IDR-IIsim?
  • Scope and Future Dynamics
• Quick Start Guide
  • Prerequisites
  • Installation
  • Configure environment
  • Run the Compiler
• Mathematical Approach and Workflow
  • General Work-Flow Overview
  • Mathematical Formulation
• Input Data Specification
  • Common Structure (Process & Industry)
  • The Process Model
  • The Industry Model (Meta-file)
• Case Study: Cement Production
  • Process Overview
  • Implementation in IDR-IIsim
• Usage Guide
  • Running the Compiler
  • Using the Generated Model in Python
• Standards and Quality Assurance
  • Input Robustness
  • Automated Testing
  • Versioning
  • Coding standards

API Reference

• API Reference
  • Module main
  • Package idr_iisim