energyplus-launch


Nameenergyplus-launch JSON
Version 3.7.2 PyPI version JSON
download
home_pagehttps://github.com/NREL/EP-Launch
SummaryGraphical Interface and Workflow Manager for EnergyPlus
upload_time2024-04-24 15:29:42
maintainerNone
docs_urlNone
authorJason Glazer and Edwin Lee for the United States Department of Energy
requires_pythonNone
licenseModifiedBSD
keywords energyplus_launch ep_launch energyplus eplus energy+ building simulation whole building energy simulation heat transfer hvac modeling
VCS
bugtrack_url
requirements tkmacosx PLAN-Tools sphinx coverage coveralls pytest flake8 wheel
Travis-CI No Travis.
coveralls test coverage
            # EnergyPlus Launch

[![GitHub release](https://img.shields.io/github/release/nrel/ep-launch.svg?style=for-the-badge)](https://github.com/nrel/ep-launch/releases/latest)

Cross platform replacement for EP-Launch for EnergyPlus, written in Python using the `tkinter` graphics library.

## Documentation

[![Documentation](https://img.shields.io/readthedocs/ep-launch?label=Docs&logo=read%20the%20docs&style=for-the-badge)](https://ep-launch.readthedocs.io/en/latest/?badge=latest)

The project is documented (currently very sparsely) using Sphinx, and automatically generated in [html](https://ep-launch.readthedocs.io/en/) by ReadTheDocs.

## Testing

[![PEP8 Enforcement](https://img.shields.io/github/actions/workflow/status/NREL/EP-Launch/flake8.yml?label=Flake8&logo=github&style=for-the-badge)](https://github.com/NREL/EP-Launch/actions/workflows/flake8.yml)
[![Unit Tests](https://img.shields.io/github/actions/workflow/status/NREL/EP-Launch/unit_tests.yml?label=Unit%20Tests&logo=github&style=for-the-badge)](https://github.com/NREL/EP-Launch/actions/workflows/unit_tests.yml)
[![Coverage Status](https://img.shields.io/coveralls/github/NREL/EP-Launch?label=Coverage&logo=coveralls&style=for-the-badge)](https://coveralls.io/github/NREL/EP-Launch?branch=main)

The project is tested using standard Python unit testing practices.
Each commit is automatically tested with Github Actions on Windows, Mac, Ubuntu 20.04 and Ubuntu 22.04.
The code coverage across platforms is collected on Coveralls.

## Releases

[![Releases](https://img.shields.io/github/actions/workflow/status/NREL/EP-Launch/pypi.yml?label=Releases&logo=github&style=for-the-badge)](https://github.com/NREL/EP-Launch/actions/workflows/pypi.yml)

When a tag is created in the GitHub Repo, Github Actions builds a Python wheel and uploads it to PyPi: https://pypi.org/project/ep-launch/.
The packages can be downloaded using standard `pip install energyplus-launch` commands.
Once Pip installed, desktop shortcuts and launchers can be configured using the `energyplus-launch-configure` command from the same Python environment.

## Development

Basic development dependencies are installed with `pip install -r requirements.txt`.
This cross platform GUI application is built around the tkinter framework, so no additional dependencies are needed for the GUI.
The application can be run by executing the module as `python -m eplaunch` file.
To run the unit test suite, simply execute `nosetests`.
Unit test results will appear in the console, and coverage results will be in a `cover` directory.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NREL/EP-Launch",
    "name": "energyplus-launch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "energyplus_launch, ep_launch, EnergyPlus, eplus, Energy+, Building Simulation, Whole Building Energy Simulation, Heat Transfer, HVAC, Modeling",
    "author": "Jason Glazer and Edwin Lee for the United States Department of Energy",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/38/b8/d6f5080ecf04dc04c5fd7bbb77ddffc05419db70fca5ae2428ddb27486cc/energyplus_launch-3.7.2.tar.gz",
    "platform": "Linux (Tested on Ubuntu)",
    "description": "# EnergyPlus Launch\n\n[![GitHub release](https://img.shields.io/github/release/nrel/ep-launch.svg?style=for-the-badge)](https://github.com/nrel/ep-launch/releases/latest)\n\nCross platform replacement for EP-Launch for EnergyPlus, written in Python using the `tkinter` graphics library.\n\n## Documentation\n\n[![Documentation](https://img.shields.io/readthedocs/ep-launch?label=Docs&logo=read%20the%20docs&style=for-the-badge)](https://ep-launch.readthedocs.io/en/latest/?badge=latest)\n\nThe project is documented (currently very sparsely) using Sphinx, and automatically generated in [html](https://ep-launch.readthedocs.io/en/) by ReadTheDocs.\n\n## Testing\n\n[![PEP8 Enforcement](https://img.shields.io/github/actions/workflow/status/NREL/EP-Launch/flake8.yml?label=Flake8&logo=github&style=for-the-badge)](https://github.com/NREL/EP-Launch/actions/workflows/flake8.yml)\n[![Unit Tests](https://img.shields.io/github/actions/workflow/status/NREL/EP-Launch/unit_tests.yml?label=Unit%20Tests&logo=github&style=for-the-badge)](https://github.com/NREL/EP-Launch/actions/workflows/unit_tests.yml)\n[![Coverage Status](https://img.shields.io/coveralls/github/NREL/EP-Launch?label=Coverage&logo=coveralls&style=for-the-badge)](https://coveralls.io/github/NREL/EP-Launch?branch=main)\n\nThe project is tested using standard Python unit testing practices.\nEach commit is automatically tested with Github Actions on Windows, Mac, Ubuntu 20.04 and Ubuntu 22.04.\nThe code coverage across platforms is collected on Coveralls.\n\n## Releases\n\n[![Releases](https://img.shields.io/github/actions/workflow/status/NREL/EP-Launch/pypi.yml?label=Releases&logo=github&style=for-the-badge)](https://github.com/NREL/EP-Launch/actions/workflows/pypi.yml)\n\nWhen a tag is created in the GitHub Repo, Github Actions builds a Python wheel and uploads it to PyPi: https://pypi.org/project/ep-launch/.\nThe packages can be downloaded using standard `pip install energyplus-launch` commands.\nOnce Pip installed, desktop shortcuts and launchers can be configured using the `energyplus-launch-configure` command from the same Python environment.\n\n## Development\n\nBasic development dependencies are installed with `pip install -r requirements.txt`.\nThis cross platform GUI application is built around the tkinter framework, so no additional dependencies are needed for the GUI.\nThe application can be run by executing the module as `python -m eplaunch` file.\nTo run the unit test suite, simply execute `nosetests`.\nUnit test results will appear in the console, and coverage results will be in a `cover` directory.\n\n\n",
    "bugtrack_url": null,
    "license": "ModifiedBSD",
    "summary": "Graphical Interface and Workflow Manager for EnergyPlus",
    "version": "3.7.2",
    "project_urls": {
        "Homepage": "https://github.com/NREL/EP-Launch"
    },
    "split_keywords": [
        "energyplus_launch",
        " ep_launch",
        " energyplus",
        " eplus",
        " energy+",
        " building simulation",
        " whole building energy simulation",
        " heat transfer",
        " hvac",
        " modeling"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "291a554e228580a634dc60b1a6eb582beeaabe5c05377571fed201f2c244f917",
                "md5": "347db1746e839406b83cf15422cc2656",
                "sha256": "50f6ec9ddf266558cb92b9cbe4ac552c24c17ce1c9230a8cd9f4d48d64dd5c73"
            },
            "downloads": -1,
            "filename": "energyplus_launch-3.7.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "347db1746e839406b83cf15422cc2656",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 120894,
            "upload_time": "2024-04-24T15:29:35",
            "upload_time_iso_8601": "2024-04-24T15:29:35.133153Z",
            "url": "https://files.pythonhosted.org/packages/29/1a/554e228580a634dc60b1a6eb582beeaabe5c05377571fed201f2c244f917/energyplus_launch-3.7.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38b8d6f5080ecf04dc04c5fd7bbb77ddffc05419db70fca5ae2428ddb27486cc",
                "md5": "bc6f03d37c9a6069aa90f42989ac0e8d",
                "sha256": "7e50b4dda110794893bc103c2a024c73120b211c5bcb72e88256567e1aa95a47"
            },
            "downloads": -1,
            "filename": "energyplus_launch-3.7.2.tar.gz",
            "has_sig": false,
            "md5_digest": "bc6f03d37c9a6069aa90f42989ac0e8d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 44110,
            "upload_time": "2024-04-24T15:29:42",
            "upload_time_iso_8601": "2024-04-24T15:29:42.396519Z",
            "url": "https://files.pythonhosted.org/packages/38/b8/d6f5080ecf04dc04c5fd7bbb77ddffc05419db70fca5ae2428ddb27486cc/energyplus_launch-3.7.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-24 15:29:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NREL",
    "github_project": "EP-Launch",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "tkmacosx",
            "specs": []
        },
        {
            "name": "PLAN-Tools",
            "specs": [
                [
                    "==",
                    "0.7"
                ]
            ]
        },
        {
            "name": "sphinx",
            "specs": []
        },
        {
            "name": "coverage",
            "specs": []
        },
        {
            "name": "coveralls",
            "specs": []
        },
        {
            "name": "pytest",
            "specs": [
                [
                    ">=",
                    "7.1.2"
                ]
            ]
        },
        {
            "name": "flake8",
            "specs": []
        },
        {
            "name": "wheel",
            "specs": []
        }
    ],
    "lcname": "energyplus-launch"
}
        
Elapsed time: 0.24919s