{"id":34024070,"url":"https://github.com/czagoni/darkgreybox","last_synced_at":"2026-04-08T15:32:32.974Z","repository":{"id":44722301,"uuid":"281379603","full_name":"czagoni/darkgreybox","owner":"czagoni","description":"DarkGreyBox: An open-source data-driven python building thermal model inspired by Genetic Algorithms and Machine Learning","archived":false,"fork":false,"pushed_at":"2024-03-01T13:14:04.000Z","size":3754,"stargazers_count":46,"open_issues_count":3,"forks_count":19,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-01-08T02:12:03.807Z","etag":null,"topics":["data-science","genetic-algorithm","machine-learning","model","python","thermal"],"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/czagoni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-21T11:31:47.000Z","updated_at":"2025-12-31T11:01:42.000Z","dependencies_parsed_at":"2023-02-10T04:15:53.538Z","dependency_job_id":null,"html_url":"https://github.com/czagoni/darkgreybox","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/czagoni/darkgreybox","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czagoni%2Fdarkgreybox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czagoni%2Fdarkgreybox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czagoni%2Fdarkgreybox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czagoni%2Fdarkgreybox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/czagoni","download_url":"https://codeload.github.com/czagoni/darkgreybox/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/czagoni%2Fdarkgreybox/sbom","scorecard":{"id":314956,"data":{"date":"2025-08-11","repo":{"name":"github.com/czagoni/darkgreybox","commit":"280a7cd5849ad1c109c7aca8b68c52f09f1ca3f3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"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":-1,"reason":"no workflows found","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":-1,"reason":"No tokens found","details":null,"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":"Code-Review","score":0,"reason":"Found 2/30 approved changesets -- score normalized to 0","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":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 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-17T23:59:04.297Z","repository_id":44722301,"created_at":"2025-08-17T23:59:04.297Z","updated_at":"2025-08-17T23:59:04.297Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31562688,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-08T14:31:17.711Z","status":"ssl_error","status_checked_at":"2026-04-08T14:31:17.202Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["data-science","genetic-algorithm","machine-learning","model","python","thermal"],"created_at":"2025-12-13T16:04:32.498Z","updated_at":"2026-04-08T15:32:32.966Z","avatar_url":"https://github.com/czagoni.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dark Grey Box\n\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n[![CircleCI](https://circleci.com/gh/czagoni/darkgreybox.svg?style=shield)](https://circleci.com/gh/czagoni/darkgreybox)\n[![PyPI version](https://badge.fury.io/py/darkgreybox.svg)](https://badge.fury.io/py/darkgreybox)\n\n## DarkGreyBox: An open-source data-driven python building thermal model inspired by Genetic Algorithms and Machine Learning\n\n### Read the medium article here: https://medium.com/analytics-vidhya/data-driven-thermal-models-for-buildings-15385f744fc5\n\nConstructing simple, accurate and easy-to-interpret thermal models for existing buildings is essential in reducing the environmental impact of our built environment. DarkGreyBox provides a data-driven approach to constructing and fitting RC-equivalent grey box thermal models for buildings, within the classic Machine Learning (ML) framework for straightforward model performance evaluation. \n\nA large number of competing models can be set up in easy-to-configure pipelines and the best performing models are selected based on principles inspired by Genetic Algorithms (GA). This approach also addresses the main disadvanatages of classical grey-box thermal modelling techniques by not requiring initial condition values for the thermal parameters to be pre-calculated and also not requiring an excitation signal to be injected into the building for successful model convergence and evaluation.\n \nThe massive advantages of using a DarkGreyBoxModel over a black-box (i.e. Machine Learning) model - e.g. a deep sequence-to-sequence model - are that it is easily interpreted by humans and that it slots easily into other modelling frameworks. E.g. to model the behaviour of a building with its connected heating system, simply construct a heat source model in a MILP framework and the grey-box building thermal model just slots in as a set of linear differential equations with a handful of parameters. Doing this with a deep ML model would be quite tricky. \n\nThe easiest way to get familiar with DarkGreyBox is to look at the [tutorials](docs/tutorials/).\n\n## Installation\n\n### Dependencies\n\nDarkGreyBox requires:\n\n- Python (\u003e= 3.6)\n- lmfit \n- pandas \n- joblib \n\nNote: these are only the core dependencies and you will most likely want to install either the optional dependencies or your preferred custom alternatives to them.\n\n### User installation from PyPi package (latest release)\n\nInstall DarkGreyBox via `pip`:\n```bash\npip install darkgreybox\n```\n\n#### Optional Dependencies\n\nThis gives you a headstart for using DarkGreyBox in anger.\n\n- scikit-learn \n- numdifftools \n- statsmodels \n- matplotlib \n- jupyter \n- notebook \n\nYou can install these additional dependencies via pip:\n```bash\npip install darkgreybox[dev]\n```\n\n### User installation from source repository\n\nYou can check the latest sources with the command::\n```bash\ngit clone https://github.com/czagoni/darkgreybox.git\n```\n\nYou can install the dev dependencies (from the root of the repository):\n```bash\npip install -e .'[dev]'\n```\n\n## Documentation\n\nTo access the tutorials you need to have cloned DarkGreyBox from the source repository (see above).\n\n### Tutorials\n\nThe easiest way to get into the details of how DarkGreyBox works is through following the tutorials:\n\n* [Demo Notebook 01 - Ti Model Direct Fit](docs/tutorials/darkgrey_poc_demo_01.ipynb): This notebook demonstrates the direct usage of the DarkGreyBox models via a simple fitting example for a Ti model.\n* [Demo Notebook 02 - TiTe Model Direct Fit FAIL](docs/tutorials/darkgrey_poc_demo_02.ipynb): This notebook demonstrates the direct usage of the DarkGreyBox models via a simple fitting example for a TiTe model. In this case a local minimum is found during the fitting process and the model heavily oscillates making it unusable.\n* [Demo Notebook 03 - TiTe Model Wrapper Fit PASS](docs/tutorials/darkgrey_poc_demo_03.ipynb): This notebook demonstrates the usage of the DarkGreyBox models via fitting them with a wrapper function for a TiTe model.\n* [Demo Notebook 04 - DarkGreyFit](docs/tutorials/darkgrey_poc_demo_04.ipynb): This notebook demonstrates the usage of the DarkGreyBox models via fitting them with DarkGreyFit, setting up and evaluating multiple pipelines at once.\n\nLaunch a new jupyter notebook from the root of the repository:\n```bash\njupyter notebook\n```\n\n## Development\n\nWe welcome new contributors of all experience levels. \n\n### Source code\n\nYou can check the latest sources with the command::\n```bash\ngit clone https://github.com/czagoni/darkgreybox.git\n```\n\nYou can install the dev and test dependencies (from the root of the repository):\n```bash\npip install -e .'[dev,test]'\n```\n\n### Testing\n\nAfter installation, you can launch the test suite from the repo root\ndirectory (you will need to have `pytest` installed):\n```bash\npytest\n```\n\nYou can check linting from the repo root directory (you will need to have `flake8` installed):\n```bash\nflake8\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fczagoni%2Fdarkgreybox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fczagoni%2Fdarkgreybox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fczagoni%2Fdarkgreybox/lists"}