Skip to content

Repository files navigation

Verification Platform Next

CI

公開Web版

Verification Platform Next ver.1.4.0をブラウザで開く

公開Web版では、インストールせずに入力、計算、結果ファイルの取得を行えます。 計算は1件ずつ処理するため、混雑時は画面に表示される順番をお待ちください。 詳細CSVは通常計算時には作成せず、「出力ファイル」タブの 「CSVファイルを出力」を押したときだけ作成します。 「JSONファイルから計算」では、旧版と現行版の入力JSONを実行できます。旧JSONで 不足する追加項目は、現在版のデフォルト値で自動的に補完されます。 入力ファイルと計算成果物は一時的に保存されるため、機密情報や個人情報を含む データはアップロードしないでください。

住宅の省エネルギー性能を検証するための計算エンジン、入力スキーマ、Gradio UIを まとめたPythonモノレポです。正式版は ver.1.4.0 です。

本リポジトリは、建築研究所が公開する住宅のエネルギー消費性能計算プログラム pyheesを基礎とし、検証用の入力画面、床下空調などの拡張計算、数値回帰試験を 統合しています。建築研究所の公式配布物ではありません。

主な機能

  • 223項目の正規入力スキーマと方式別の表示・検証条件
  • JSON入力とGradio Web UI
  • ダクト式セントラル空調、ルームエアコン、床下空調などの計算
  • 暖冷房別の年間結果、8760時間系列、グラフ、計算ログの出力
  • 製品版、ソースコミット、上流pyhees、入力SHA-256を記録するマニフェスト
  • 旧版との代表ケース比較を行うPhase 5数値回帰
  • Google Colabおよび任意のCloud Runデプロイ

動作環境

  • Python 3.12.11以上、3.13未満
  • Windows、macOS、Linux、またはGoogle Colab

インストールと起動

git clone https://github.com/iguchi-lab/Verification-Platform-Next.git
cd Verification-Platform-Next
python -m pip install --upgrade pip
python -m pip install -e apps/gradio
verification-platform

Poetryを使用する場合は次のとおりです。

poetry install
poetry run verification-platform

Colabでは notebooks/Verification_Platform_Next.ipynb を開いてください。

検証

リポジトリ全体の契約・回帰試験と静的検査を実行します。

python -m pytest -q
ruff check .
python scripts/run_phase5_regression.py

計算エンジン内部の履歴試験は次のコマンドで実行します。

cd packages/pyhees-jjj
python -m pytest src/tests -q -o addopts=""

数値基準は、差分の計算上・規格上の影響を確認せずに更新しないでください。

ディレクトリ構成

apps/gradio/                 Gradio Web UIと実行サービス
packages/verification-core/ 入力スキーマと共通契約
packages/pyhees-jjj/         建研由来コードと検証用拡張計算
notebooks/                   Google Colabランチャー
regression/phase5/           代表ケースの固定数値基準
tests/                       パッケージ横断の契約・回帰試験
docs/                        設計、入力、計算仕様、リリース資料

計算成果物と版管理

成果物名には製品版を付け、同じ接頭辞のマニフェストへソースコミット、上流 pyhees版、床下仕様、入力SHA-256を記録します。詳細は docs/RELEASING.mdを参照してください。

生成したJSON、CSV、ログはGitへ追加せず、outputs/などの作業用ディレクトリに 保存してください。

Cloud Runへの任意デプロイ

.github/workflows/deploy-cloud-run.ymlは手動実行専用です。GitHub Actionsの variablesとsecretsへGoogle Cloudのプロジェクト、リージョン、Artifact Registry、 Workload Identity Federationを設定して使用します。mainへのpushでは自動 デプロイされません。

既定のCloud Run構成は最大1インスタンスです。複数の利用者から計算要求があった場合は Gradioのキューで受け付け、1件ずつ順番に計算します。待機上限は5件、計算成果物の 保持期間は24時間で、次の環境変数から変更できます。

  • GRADIO_QUEUE_MAX_SIZE: 待機可能件数。0以下は無制限
  • VERIFICATION_RESULT_TTL_SECONDS: 成果物保持秒数。0以下は自動削除なし
  • VERIFICATION_OUTPUT_DIR: 計算ID別ディレクトリを作る親ディレクトリ

ローカルでコンテナを確認する場合は次のとおりです。

docker build -t verification-platform-next .
docker run --rm -p 8080:8080 verification-platform-next

ドキュメント

コントリビューション

不具合報告や改善提案はGitHub Issue、変更提案はPull Requestで受け付けます。 計算式または数値結果を変更する場合は、根拠資料、影響する系列・年間値、実行した 試験を明記してください。詳しくはCONTRIBUTING.mdを参照して ください。

About

住宅省エネルギー性能の検証用計算エンジン・入力スキーマ・Gradio UI

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages