[](https://dev.azure.com/openergy/opyplus/_build/latest?definitionId=1&branchName=master)
# opyplus
opyplus is a package allowing to work with EnergyPlus in Python.
More specifically, it allows to:
* Parse, query and modify idf files efficiently, with a number of checks ensuring that your idf file remains correct
throughout your work
* Parse and create epw files
* Launch simulations on EnergyPlus
* Parse EnergyPlus output files
## Install
To install opyplus, run: `pip install opyplus` or `conda install -c conda-forge opyplus`
## Documentation
Documentation is available at https://opyplus.readthedocs.io
## Compatibility
### Python versions
opyplus is designed to work with python 3.6 and newer.
It is currently automatically tested against the following python versions:
* 3.6
* 3.7
### EnergyPlus versions
opyplus is designed to work with any EnergyPlus version.
Currently, it is automatically tested against the following versions (listed in TESTED_EPLUS_VERSIONS : oplus.tests.util):
* 9.0.1
Each test is therefore run multiple times : once per tested version. To automatically run a test on all versions, use
eplus_tester function (oplus.tests.util).
### Operating system
opyplus is designed to work with any Operating System. It is automatically tested against the latest versions of
the following OS:
* Ubuntu
* MacOS
* Microsoft Windows
## Contributing
### Local testing
Install pytest and the packages listed in requirements.txt using pip or conda.
Install EnergyPlus v9.0.1.
At the root of the repository, run pytest: `python -m pytest`.
### Flake8
We use flake8 for style enforcement, including docstrings.
To run it, install flake8 and flake8-docstrings using pip or conda.
At the root of the repository, run flake8: `python -m flake8 opyplus/`
### Documentation
To build the configuration:
install the requirements in docs/requirements.txt
run `make html` in opyplus docs directory.
To ensure the examples in the documentation remain up to date, they are tested using the doctest extension:
https://www.sphinx-doc.org/en/master/usage/extensions/doctest.html
run `make doctest` in opyplus docs directory to test the documentation.
When adding code samples to the documentation, please use when possible the doctest extension, as it helps ensure your
samples will be kept up to date: use `.. testcode::` and `.. testoutput::` rather than `.. code-block:: python`.
### Release workflow
1. Developer XX works on his branch (XX-...).
When finished, he completes the RELEASE.md without writing the version number (he completes under ## next).
He then creates a pull request into master.
2. Once the pull request has been accepted by an administrator (tests must pass, among other things), the branch is merged on master.
3. When administrator wants to create a version, he completes RELEASE.md with version number, sets it version.py, commits and creates a tag (vX.X.X).
He then pushes. The tests should succeed because all pull requests tests have succeeded.
A conda and pip build will then automatically be performed by Azure Pipelines.
Raw data
{
"_id": null,
"home_page": "https://github.com/openergy/opyplus",
"name": "opyplus",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Openergy development team",
"author_email": "contact@openergy.fr",
"download_url": "https://files.pythonhosted.org/packages/d2/f5/9dd4816920588a01597e2dcb3be53a1361b2c51cb8f776030d2af5552b6d/opyplus-1.4.2.tar.gz",
"platform": null,
"description": "\n[](https://dev.azure.com/openergy/opyplus/_build/latest?definitionId=1&branchName=master)\n\n\n\n\n# opyplus\n\nopyplus is a package allowing to work with EnergyPlus in Python.\n\nMore specifically, it allows to:\n* Parse, query and modify idf files efficiently, with a number of checks ensuring that your idf file remains correct\nthroughout your work\n* Parse and create epw files\n* Launch simulations on EnergyPlus\n* Parse EnergyPlus output files\n\n## Install\n\nTo install opyplus, run: `pip install opyplus` or `conda install -c conda-forge opyplus`\n\n## Documentation\n\nDocumentation is available at https://opyplus.readthedocs.io\n\n## Compatibility\n\n### Python versions\n\nopyplus is designed to work with python 3.6 and newer.\n\nIt is currently automatically tested against the following python versions:\n* 3.6\n* 3.7\n\n### EnergyPlus versions\n\nopyplus is designed to work with any EnergyPlus version.\nCurrently, it is automatically tested against the following versions (listed in TESTED_EPLUS_VERSIONS : oplus.tests.util):\n* 9.0.1\n\nEach test is therefore run multiple times : once per tested version. To automatically run a test on all versions, use\neplus_tester function (oplus.tests.util).\n\n### Operating system\n\nopyplus is designed to work with any Operating System. It is automatically tested against the latest versions of \nthe following OS:\n* Ubuntu\n* MacOS\n* Microsoft Windows\n\n## Contributing\n\n### Local testing\n\nInstall pytest and the packages listed in requirements.txt using pip or conda.\n\nInstall EnergyPlus v9.0.1.\n\nAt the root of the repository, run pytest: `python -m pytest`.\n\n### Flake8\n\nWe use flake8 for style enforcement, including docstrings.\n\nTo run it, install flake8 and flake8-docstrings using pip or conda.\n\nAt the root of the repository, run flake8: `python -m flake8 opyplus/`\n\n### Documentation\n\nTo build the configuration:\n\ninstall the requirements in docs/requirements.txt\n\nrun `make html` in opyplus docs directory.\n\nTo ensure the examples in the documentation remain up to date, they are tested using the doctest extension:\nhttps://www.sphinx-doc.org/en/master/usage/extensions/doctest.html\n\nrun `make doctest` in opyplus docs directory to test the documentation.\n\nWhen adding code samples to the documentation, please use when possible the doctest extension, as it helps ensure your\nsamples will be kept up to date: use `.. testcode::` and `.. testoutput::` rather than `.. code-block:: python`.\n\n### Release workflow\n\n1. Developer XX works on his branch (XX-...).\nWhen finished, he completes the RELEASE.md without writing the version number (he completes under ## next).\nHe then creates a pull request into master.\n2. Once the pull request has been accepted by an administrator (tests must pass, among other things), the branch is merged on master.\n3. When administrator wants to create a version, he completes RELEASE.md with version number, sets it version.py, commits and creates a tag (vX.X.X).\nHe then pushes. The tests should succeed because all pull requests tests have succeeded.\nA conda and pip build will then automatically be performed by Azure Pipelines. \n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python package to work with Energyplus input and output",
"version": "1.4.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f04e8354aaac79592e18ba73322462d7ec121990013d5a40eea9bcd2e3e24643",
"md5": "075f3ce433028f4c663fa459f96db786",
"sha256": "37b03ec71ba5f0200f326fee6f55e6c35ab644abd3afaa22a0082097c29a5986"
},
"downloads": -1,
"filename": "opyplus-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "075f3ce433028f4c663fa459f96db786",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8601181,
"upload_time": "2022-06-15T08:44:32",
"upload_time_iso_8601": "2022-06-15T08:44:32.645440Z",
"url": "https://files.pythonhosted.org/packages/f0/4e/8354aaac79592e18ba73322462d7ec121990013d5a40eea9bcd2e3e24643/opyplus-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d2f59dd4816920588a01597e2dcb3be53a1361b2c51cb8f776030d2af5552b6d",
"md5": "86ba737c7bb66ada3cfca2058eed8632",
"sha256": "9ba085ca0fb2b426b26410ca50dace2144ebcad90e2d7274389c8705d3e96cd7"
},
"downloads": -1,
"filename": "opyplus-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "86ba737c7bb66ada3cfca2058eed8632",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8392386,
"upload_time": "2022-06-15T08:44:35",
"upload_time_iso_8601": "2022-06-15T08:44:35.705319Z",
"url": "https://files.pythonhosted.org/packages/d2/f5/9dd4816920588a01597e2dcb3be53a1361b2c51cb8f776030d2af5552b6d/opyplus-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-15 08:44:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "openergy",
"github_project": "opyplus",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pandas",
"specs": [
[
">=",
"0.20.0"
],
[
"<",
"2.0.0"
]
]
},
{
"name": "unidecode",
"specs": [
[
">=",
"1.0.22"
],
[
"<",
"2.0"
]
]
},
{
"name": "python-slugify",
"specs": [
[
">=",
"3.0.2"
],
[
"<",
"4.0"
]
]
},
{
"name": "cchardet",
"specs": [
[
"<",
"3.0"
],
[
">=",
"2.1.4"
]
]
}
],
"lcname": "opyplus"
}
JSON
