{"id":34028788,"url":"https://github.com/rwth-ebc/aixcalibuha","last_synced_at":"2026-04-20T15:00:19.891Z","repository":{"id":41875844,"uuid":"395279204","full_name":"RWTH-EBC/AixCaliBuHA","owner":"RWTH-EBC","description":"Wield this tool to be King Arthur of your models.","archived":false,"fork":false,"pushed_at":"2026-04-20T14:22:30.000Z","size":52443,"stargazers_count":10,"open_issues_count":10,"forks_count":3,"subscribers_count":15,"default_branch":"master","last_synced_at":"2026-04-20T14:40:55.336Z","etag":null,"topics":["maintained","tool"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RWTH-EBC.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-08-12T10:22:55.000Z","updated_at":"2026-04-20T14:05:57.000Z","dependencies_parsed_at":"2023-09-23T05:08:58.954Z","dependency_job_id":"c4abf579-929a-4b52-9c2f-e3579b48753a","html_url":"https://github.com/RWTH-EBC/AixCaliBuHA","commit_stats":{"total_commits":496,"total_committers":17,"mean_commits":"29.176470588235293","dds":"0.35282258064516125","last_synced_commit":"6bfe1d6c51c9af1f1874d7a30a55fc336c61700e"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/RWTH-EBC/AixCaliBuHA","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FAixCaliBuHA","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FAixCaliBuHA/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FAixCaliBuHA/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FAixCaliBuHA/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RWTH-EBC","download_url":"https://codeload.github.com/RWTH-EBC/AixCaliBuHA/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RWTH-EBC%2FAixCaliBuHA/sbom","scorecard":{"id":117007,"data":{"date":"2025-08-11","repo":{"name":"github.com/RWTH-EBC/AixCaliBuHA","commit":"285a15b82f4e24cc4454072b7ee6d4dbed010d92"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5,"checks":[{"name":"Code-Review","score":8,"reason":"Found 6/7 approved changesets -- score normalized to 8","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"14 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/issue-tracker.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: third-party GitHubAction not pinned by hash: .github/workflows/issue-tracker.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/RWTH-EBC/AixCaliBuHA/issue-tracker.yml/master?enable=pin","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2024-4 / GHSA-2mqj-m65w-jghx","Warn: Project is vulnerable to: PYSEC-2023-165 / GHSA-cwvm-v4w8-q58c","Warn: Project is vulnerable to: PYSEC-2023-137 / GHSA-pr76-5cm5-w9cj","Warn: Project is vulnerable to: PYSEC-2023-161 / GHSA-wfm5-v35h-vwf4","Warn: Project is vulnerable to: GHSA-6p56-wp2h-9hxr","Warn: Project is vulnerable to: GHSA-fpfv-jqm9-f5jm"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 29 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T01:35:21.126Z","repository_id":41875844,"created_at":"2025-08-16T01:35:21.126Z","updated_at":"2025-08-16T01:35:21.126Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32052534,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-20T11:35:06.609Z","status":"ssl_error","status_checked_at":"2026-04-20T11:34:48.899Z","response_time":94,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["maintained","tool"],"created_at":"2025-12-13T17:19:16.534Z","updated_at":"2026-04-20T15:00:19.883Z","avatar_url":"https://github.com/RWTH-EBC.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![E.ON EBC RWTH Aachen University](./docs/EBC_Logo.png)\n\n[![DOI](https://joss.theoj.org/papers/10.21105/joss.03861/status.svg)](https://doi.org/10.21105/joss.03861)\n[![pylint](https://rwth-ebc.github.io/AixCaliBuHA/master/pylint/pylint.svg)](https://rwth-ebc.github.io/AixCaliBuHA/master/pylint/pylint.html)\n[![documentation](https://rwth-ebc.github.io/AixCaliBuHA/master/docs/doc.svg)](https://rwth-ebc.github.io/AixCaliBuHA/master/docs/index.html)\n[![coverage](https://rwth-ebc.github.io/AixCaliBuHA/master/coverage/badge.svg)](https://rwth-ebc.github.io/AixCaliBuHA/master/coverage)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![build](https://rwth-ebc.github.io/AixCaliBuHA/master/build/build.svg)](https://rwth-ebc.github.io/AixCaliBuHA/master/build/build.svg)\n\n# AixCaliBuHA\n\n**Aix** (from French Aix-la-Chapelle) \n**Cali**bration for **Bu**ilding and **H**V**A**C Systems\n\nThis framework automates the process of calibrating models used in Building\nand HVAC Simulations.\n\n# Key features\n- Performing a **Sensitivity Analysis** to analyze your model and discover tuner parameters for the calibration\n- **Calibration** of a given model based on the tuner parameters, the calibration classes and specified goals to evaluate the objective function of the underlying optimization\n\n# Installation\n\nTo install, simply run\n```\npip install aixcalibuha\n```\n\nIf you encounter an error with the installation of `scikit-learn`, first install `scikit-learn` separately and then install `aixcalibuha`:\n\n```\npip install scikit-learn\npip install aixcalibuha\n```\n\nIf this still does not work, we refer to the troubleshooting section of `scikit-learn`: https://scikit-learn.org/stable/install.html#troubleshooting. Also check [issue 23](https://github.com/RWTH-EBC/ebcpy/issues/23) for updates.\n\nIn order to help development, install it as an egg:\n\n```\ngit clone --recurse-submodules https://github.com/RWTH-EBC/AixCaliBuHA\npip install -e AixCaliBuHA\n```\n\n# Framework structure\n\nThe core idea and motivation of `AixCaliBuHA` is described in the [paper](https://joss.theoj.org/papers/10.21105/joss.03861).\nThe following image illustrates the overall toolchain automated by `AixCaliBuHA`.\n\n![plot](docs/img/paper_fig_1.png)\n\n\nAt the core of `AixCaliBuHA` lays the definition of data types, that link the python data types to the underlying optimization problem and are used for all subsequent steps.\nThis image below illustrates this. For more information, check the [paper](paper/AixCaliBuHA_10.21105.joss.03861.pdf) and the subsequent section on how to get started.\n\n![plot](docs/img/paper_fig_2.png)\n\n\n# How to get started?\nWe differ this section into two parts. How to get started with the theory of calibration and how to get started with using this repo.\n\n## How can I calibrate my model?\nWhile we aim at automating most parts of a calibration process, you still have to specify the inputs and the methods you want to use.\nWe therefore recommend to:\n1. Analyze the physical system and theoretical model you want to calibrate\n2. Identify inputs and outputs of the system and model\n3. Get to know your tuner parameters and how they affect your model\n4. Plan your experiments and perform them\n5. Learn about the methods provided for calibration (statistical measures (RMSE, etc.), optimization, ...)\n6. **Always be critical** about the results of the process. If the model approach or the experiment is faulty, the calibration will perform accordingly. \n\n## How to start with AixCaliBuHA?\nWe have three services in place to help you with the setup of `AixCaliBuHA`. For the basics on using this repo, we recommend the Jupyter Notebook.\nIf you want to setup your calibration models (in Modelica) and quickly start your first calibration, we provide a guided setup.\n\n### Jupyter Notebook\nWe recommend running our jupyter-notebook to be guided through a **helpful tutorial**.  \nFor this, run the following code:\n```\n# If jupyter is not already installed:\npip install jupyter\n# Go into your aixcalibuha-folder (cd \\path_to_\\AixCaliBuHA) or change the to the absolute path of the tutorial.ipynb and run:\njupyter notebook tutorial\\tutorial.ipynb\n```\n\n### Examples\nClone this repo and look at the examples\\README.md file.\nHere you will find several examples to execute.\n\n### Visualization\n\nWe provide different plots to make the process of calibration clearer to you. We will go into detail on the different plots, what they tell you and how you can enable/disable them. We refer the plot names with the file names they get.\n\n#### objective_plot:\n\n![plot](tutorial/tutorial/objective_plot.svg)\n\n**What do we see?** The solver in use was \"scipy_differential_evolution\" using the \"best1bin\" method. After around 200 iterations, the solver begins to converge. The last 150 itertions don't yield a far better solution, it is ok to stop the calibration here. You can do this using a `KeyboardInterrupt` / `STRG + C`.\n\n**How can we enable/disable the plot?** Using the `show_plot=True` keyword argument (default is `True`)\n\n#### tuner_parameter_plot:\n![plot](tutorial/tutorial/tuner_parameter_plot.svg)\n\n**What do we see?** The variation of values of the tuner parameters together with their specified boundaries (red lines). The tuner parameters vary significantly in the first 200 iterations. At convergence the values obviously also converge.\n\n**How can we enable/disable the plot?** Using the `show_plot=True` keyword argument (default is `True`)\n\n#### tsd_plot: Created for two different classes - \"stationary\" and \"Heat up\"\n![plot](tutorial/tutorial/tsd_plot_heat_up.svg)\n![plot](tutorial/tutorial/tsd_plot_stationary.svg)\n\n\n**What do we see?** The measured and simulated trajectories of our selected goals. The grey part is not used for the evaluation of the objective function. As these values are `NaN`, matplotlib may interpolate linearly between the points, so don't worry if the trajectory is not logical in the grey area. Note that the inital values for the class \"stationary\" are not matching the initial values of the measured data. Even if the parameters are set properly, the objective would yield a bad result. In this case you have to adapt the inital values of your model directly in the Modelica code (see section \"Best practices\").\n\n**How can we enable/disable the plot?** Using the `create_tsd_plot=True` keyword argument for showing it each iteration, the  `save_tsd_plot=True` for saving each of these plots. (Default is `True` and `False`, respectivly.)\n\n\n#### tuner_parameter_intersection_plot:\n![plot](tutorial/tutorial/tuner_parameter_intersection_plot.svg)\n\n**What do we see?** This plot is generated if you calibrate multiple classes **AND** different classes pyrtially have the same tuner parameters (an intersection of `tuner_paras`). In this case multiple \"best\" values arise for one tuner parameter. The plot shows the distribution of the tuner-parameters if an intersection is present. You will also be notified in the log file. In the case this plot appears, you have to decide which value to choose. If they differ greatly, you may want to either perform a sensitivity analysis to check which parameter has the biggest impact OR re-evaluate your modelling decisions. \n\n**How can we enable/disable the plot?** Using the `show_plot=True` keyword argument (default is `True`)\n\n# How to cite AixCaliBuHA\n\nPlease use the following metadata to cite `AixCaliBuHA` in your research:\n\n```\n@article{Wuellhorst2022,\n  doi = {10.21105/joss.03861},\n  url = {https://doi.org/10.21105/joss.03861},\n  year = {2022},\n  publisher = {The Open Journal},\n  volume = {7},\n  number = {72},\n  pages = {3861},\n  author = {Fabian Wüllhorst and Thomas Storek and Philipp Mehrfeld and Dirk Müller},\n  title = {AixCaliBuHA: Automated calibration of building and HVAC systems},\n  journal = {Journal of Open Source Software}\n}\n```\n\n# Documentation\nVisit our official [Documentation](https://rwth-ebc.github.io/AixCaliBuHA/master/docs).\n\n# Problems?\nPlease [raise an issue here](https://github.com/RWTH-EBC/AixCaliBuHA/issues/new).\n\nFor other inquires, please contact [ebc-tools@eonerc.rwth-aachen.de](mailto:ebc-tools@eonerc.rwth-aachen.de).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-ebc%2Faixcalibuha","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frwth-ebc%2Faixcalibuha","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frwth-ebc%2Faixcalibuha/lists"}