AHOIS-pro documentation

The AHOIS-pro documentation is structured relating to its target groups:

• Stakeholder reports the vision, important feature and focuses on input and output.

• Application is for users of the model and provides an ODD description, describes relevant concepts, offers recipes and the API.

• Development provides information related to the code repository, a style guide and further information about documenting, testing, logging, and localisation.

Contents:

• Stakeholder
  • Vision
  • Important Features
    • Heterogeneous Investors
    • Detailed representation of Buildings
    • Windows of Opportunity for Investments
    • Regulation and Funding
  • Input data
  • Output and Applications
  • Presentations
• Application
  • Instructions
    • Installation
    • Run simulations
  • ODD
    • 1. Purpose and Patterns
    • 2. Entities, state variables, scales
    • 3. Process Overview and Scheduling
    • 4. Design Concepts
    • 5. Initialisation
    • 6. Input Data
    • 7. Submodels
  • Glossary
  • Concepts
    • Configuration
    • Random Number Generation
    • Logging
    • Output
  • Recipes
    • SLURM-managed Cluster Runs
    • Analysis
  • APIs
    • Model module
    • Run module
    • agents package
    • agents.base package
    • modules package
    • analysis package
    • experiments package
    • helpers package
    • interventions package
    • plotting package
    • server package
    • tests package
    • modules package
• Development
  • GitLab Repository
  • Publish code and doc
  • Style Guide for Code
    • Documenting code
    • String formatting
  • Testing
  • Linting
  • Documentation Guide
    • Building documentation
  • Localisation
  • FutureWarning
  • Logging
  • Dynaconf Tweaks
    • Virtual environment using pipenv

Indices and tables

• Index

• Module Index

• Search Page