epmodel

v0.7.1

Data models for EnergyPlus automatically generated from EnergyPlus JSON schema using datamodel-code-generator. For more information about how to use this package see README

Latest version published 21 days ago

License: MIT

PyPI

GitHub

Package Health Score

81 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Popularity

Small

GitHub Stars: 20.83K
Forks: 1.87K
Contributors: 470

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package epmodel, we found that it has been starred 20,826 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Sep 27, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like epmodel is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 427
Open PR: 7
Last Release: 21 days ago
Last Commit: 2 days ago

Further analysis of the maintenance status of epmodel based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that epmodel demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 470
Funding: Yes

A good and healthy external contribution signal for epmodel project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like epmodel is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.9

Age: 1 year
Latest Release: 21 days ago
Dependencies: 0 Direct
Versions: 13
Maintainers: 1
Wheels: OS Independent

Readme

epmodel

epmodel is a pydantic (V2) data model for EnergyPlus modeling. The data model code itself is automatically generated from the EnergyPlus JSON schema using the datamodel-code-generator package.

Usage

Due to the size of the official EnergyPlus JSON schema, we reduce the data model scope down the a few commonly used ones. The name of these data models are list in the keys.txt file, which is also used to generate the data model code.

Expanding the scope of data model

We can add object to the data model by adding names directly to the keys.txt file.

Generate the source code

To generate the source code, run the following command inside the codegen directory:

python codegen.py

As a result, a src/epmodel/model.py file will be a generated with the data model code.

Using the data model

Using the data model object is as simple as:

import json
from epmodel import EnergyPlusModel

with open("model.epJSON", "r") as f:
    data = json.load(f)
model = EnergyPlusModel.model_validate(data)

The code above loads in the EnergyPlus epJSON model and validate it against the data model. If the mode is valid, a EnergyPlusModel object will be returned, otherwise, an ValidationError will be raised.

One of the benefits of having such data model, beyond data validation, is that we can use autocomplete in IDE to help use write the code.

Dependencies

pydantic

Dependency for code generation

datamodel-code-generator

FAQs

What is epmodel?

Data models for EnergyPlus automatically generated from EnergyPlus JSON schema using datamodel-code-generator. Visit Snyk Advisor to see a full health score report for epmodel, including popularity, security, maintenance & community analysis.

Is epmodel popular?

The python package epmodel receives a total of 273 weekly downloads. As such, epmodel popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is epmodel well maintained?

We found that epmodel demonstrated a healthy version release cadence and project activity. It has a community of 470 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is epmodel safe to use?

The python package epmodel was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 October-2024, at 14:17 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

epmodel

Usage

Expanding the scope of data model

Generate the source code

Using the data model

Dependencies

Dependency for code generation

FAQs

What is epmodel?

Is epmodel popular?

Is epmodel well maintained?

Is epmodel safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues