Skip to main content

Physics-Informed Modularized Neural Network for Building Energy Modeling

Project description

ModNN

ModNN is a Modularized Physics-Informed Neural Network for building energy modeling.

It incorporates with physics-informed model structure, loss function, and model constraints.


🚀 Installation

You can install the package using pip:

pip install modnn

🧠 Example

Please find the online Jupyter notebook for a step-by-step instruction: https://colab.research.google.com/drive/1A2jt1q53RtxGuaoym6N1PmlKELDPpYFX?usp=sharing

🧠 Update log

🧠 [2.0.0] 2025 May 9

To further improve physical consistency,

I replaced heat transfer module by set of energy balance equations,

Start from version 2.0.0

🧠 [2.0.1] 2025 May 10

Add another parameter: "envelop_mdl",

Allow user to use the new physics based module or previous data driven module.

🧠 [2.0.2] 2025 May 10

Fix bug due to parameter: "envelop_mdl",

Vectorize calculation,speed improved by ~6 times.

🧠 [3.0.0] 2025 June 11

Update datadriven modnn RC based envelop_mdl really hard to tune on new dataset

🧠 [3.0.1] 2025 June 11

Add a step function for one step ahead prediction

🧠 [3.0.2] 2025 June 11

Fix bug for step function

🧠 [3.0.3] 2025 June 11

Fix bug for step function

🧠 [3.0.4] 2025 Sept 10

Didn't work on it for 3 months, just update the latest version Will use it for BESTOpt building dynamic model

🧠 [3.0.5] 2025 Sept 15

3.0.4 CAN-NOT work at all, I mistakenly comment one line and add a new line of code

🧠 [3.0.6] 2025 Sept 15

Fix temperature unit conversion issue

🧠 [3.0.7] 2025 Sept 15

Fix step model zone module dimension issue

🧠 [3.0.8] 2025 Oct 20

Change path in saving results function, so Windows user can use it without bugs

🧪 Requirements

Python 3.7+

PyTorch

NumPy

Pandas

Matplotlib

Seaborn

scikit-learn

tqdm

📬 License

MIT License

🙋‍♂️ Author

Zixin Jiang: zjiang19@syr.edu

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

modnn-3.0.8.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

modnn-3.0.8-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file modnn-3.0.8.tar.gz.

File metadata

  • Download URL: modnn-3.0.8.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for modnn-3.0.8.tar.gz
Algorithm Hash digest
SHA256 adba1ea7c168b53f3a43905854837b7c1fac35c6be06d0c3699c691e81afc8ef
MD5 345df941f2b02c7a9dbdcaf6dbc1112f
BLAKE2b-256 48768927508d348e846638e3a2b3a44c30e965b98da4d6f464e3ee86a657827c

See more details on using hashes here.

File details

Details for the file modnn-3.0.8-py3-none-any.whl.

File metadata

  • Download URL: modnn-3.0.8-py3-none-any.whl
  • Upload date:
  • Size: 47.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for modnn-3.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 4c9e302813501b81ea7771540cf05df3557a078c8c5932cdaca22220e94ed4af
MD5 73a2e5fa361c609e199f0a32780c6e93
BLAKE2b-256 ef269f7e738bf9395a851abb6746affeb577b5b0986e84cf765ef333b45c297b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page