{ "info": { "author": "Nicolas Cellier", "author_email": "contact@nicolas-cellier.net", "bugtrack_url": null, "classifiers": [], "description": "energy+ wrapper\n==========================\n\nThis little library has been written in order to run energy+ simulation in linux and windows in a thread-safe way.\n\nThe main goal is to ensure a stable behaviour across platform and version, and\nto make the link between the e+ building model tools written in python and the different analysis and optimization tools.\n\nInstall\n=======\n\nFor now, the package is available on PyPI, and via the github repo.\n\n.. code:: shell\n\n pip install energyplus-wrapper\n pip install git+git://github.com/locie/energy_plus_wrapper.git\n\nfor the requirements.\n\nUsage\n=====\n\nvery simple use:\n\n.. code:: python\n\n from energyplus_wrapper import run\n result = run('in.idf', 'in.epw')\n\n\nAPI\n===\n\n.. code:: python\n\n def run(idf_file, weather_file,\n working_dir=\".\",\n idd_file=None,\n simulname=None,\n prefix=\"eplus\",\n out_dir=tempfile.gettempdir(),\n keep_data=False,\n keep_data_err=True,\n bin_path=None,\n eplus_path=None):\n \"\"\"\n energyplus runner using local installation.\n\n Run an energy-plus simulation with the model file (a .idf file),\n a weather file (should be a .epw) as required arguments. The output will be\n a pandas dataframe or a list of dataframe or None, depending of how many\n csv has been generated during the simulation, and requested in the model\n file. The run is multiprocessing_safe\n\n Parameters\n ----------\n idf_file : str\n the file describing the model (.idf)\n weather_file : str\n the file describing the weather data (.epw)\n working_dir : str, optional\n working directory (default: \".\")\n idd_file : None, optional\n base energy-plus file (default: None, find Energy+.idd in the\n e+ install directory if $EPLUS_DIR set, else find it on working\n dir.)\n simulname : str or None, optional (default None)\n this name will be used for temp dir id and saved outputs.\n If not provided, uuid.uuid1() is used. Be careful to avoid naming\n collision : the run will alway be done in separated folders, but the\n output files can overwrite each other if the simulname is the same.\n prefix : str, optional\n prefix of output files (default: \"eplus\")\n out_dir : str, optional\n temporary output directory (default: OS default temp folder).\n keep_data : bool, optional\n if True, do not remove the temporary folder after the simulation\n (default: False)\n keep_data_err : bool, optional\n if True, copy the temporary folder on out_dir / \"failed\" if the\n simulation fail. (default: True)\n bin_path : None, optional\n if provided, path to the EnergyPlus binary. If not provided (default),\n find it on eplus_path / EnergyPlus (if eplus_path set), or\n use the global variable EPLUS_PATH (id set), or finally\n consider that EnergyPlus is on the path\n eplus_path : None, optional\n if provided, path to the EnergyPlus.\n\n\n Returns\n -------\n pandas.DataFrame or list of pandas.DataFrame or None\n Only the csv outputs are handled : the output of the\n function will be None if any csv are generated, a pandas DataFrame\n if only one csv is generated (which seems to be the usual user\n case) or a list of DataFrames if many csv are generated.\n \"\"\"\n\n.. Credits\n.. -------\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/celliern/energy_plus_wrapper/", "keywords": "energy-plus wrapper", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "energyplus_wrapper", "package_url": "https://pypi.org/project/energyplus_wrapper/", "platform": "", "project_url": "https://pypi.org/project/energyplus_wrapper/", "project_urls": { "Homepage": "https://github.com/celliern/energy_plus_wrapper/" }, "release_url": "https://pypi.org/project/energyplus_wrapper/0.6.1/", "requires_dist": [ "pandas", "path.py" ], "requires_python": "", "summary": "some usefull function to run e+ locally", "version": "0.6.1" }, "last_serial": 4309013, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "2d62238e8c18c96ba0556bbe77bee8b2", "sha256": "37c0e0f2c24d5602b05ffab14b6dd808a821459e5d7d62d05ca8cf667c12acd8" }, "downloads": -1, "filename": "energyplus_wrapper-0.1-py3.6.egg", "has_sig": false, "md5_digest": "2d62238e8c18c96ba0556bbe77bee8b2", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 9185, "upload_time": "2017-02-18T13:03:21", "url": "https://files.pythonhosted.org/packages/56/54/024673c039f01252134c0c933767cda8e82a30e496ba410c5865dd0632e2/energyplus_wrapper-0.1-py3.6.egg" }, { "comment_text": "", "digests": { "md5": "5b8281b31508a3dc0d228c8d93f7817e", "sha256": "de6ab27169563093e54582d977a6b9dc0719681698381ea0df9aaa4959da72b6" }, "downloads": -1, "filename": "energyplus_wrapper-0.1.tar.gz", "has_sig": false, "md5_digest": "5b8281b31508a3dc0d228c8d93f7817e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4922, "upload_time": "2017-02-18T13:01:41", "url": "https://files.pythonhosted.org/packages/fe/4b/a50fe639d8435cfc01ef43a878cd5e4fdf0e2ea22853ffdb3d0e384e41cb/energyplus_wrapper-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "30f774817cdc1f548c153303135a7d2e", "sha256": "382e1045cbfdb3d291d4a2cf9b00bc68e20ac8162b0c0471663ed959687f22c6" }, "downloads": -1, "filename": "energyplus_wrapper-0.2-py2.7.egg", "has_sig": false, "md5_digest": "30f774817cdc1f548c153303135a7d2e", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 9213, "upload_time": "2017-02-18T13:26:18", "url": "https://files.pythonhosted.org/packages/7f/a3/a233d32b954fe85539292140ac12df7db5bfe99832c807ce42b14976f300/energyplus_wrapper-0.2-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "da28ba0706d93b4bd8e9bd5b0de2f7c1", "sha256": "1f3b32cbd28b815f14cabc7af5eeac95e3c8928ba3c94c7de530608eb008a41b" }, "downloads": -1, "filename": "energyplus_wrapper-0.2-py3.6.egg", "has_sig": false, "md5_digest": "da28ba0706d93b4bd8e9bd5b0de2f7c1", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 9187, "upload_time": "2017-02-18T13:04:01", "url": "https://files.pythonhosted.org/packages/7f/9f/200f681b6abd0b7eea5303bb0fc68d92ece9e022d8383d71c85eb3ead79d/energyplus_wrapper-0.2-py3.6.egg" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "37f57b0b101a2225ab0a724e77ccaba5", "sha256": "0fc427fb3910512c074d8bbe76e21a48bbb71af3906e00e6d1dee82af42af249" }, "downloads": -1, "filename": "energyplus_wrapper-0.3-py2.7.egg", "has_sig": false, "md5_digest": "37f57b0b101a2225ab0a724e77ccaba5", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 9213, "upload_time": "2017-02-18T13:26:36", "url": "https://files.pythonhosted.org/packages/bb/3d/48bc756a812f5bea0f8ee922d209a70e3e09c41a8e1941e8eeb6a4199bd1/energyplus_wrapper-0.3-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "7e48e73e5209aefd0edbeb59cec36f4d", "sha256": "f9274792bf16a498d608766ed1f2581d85bfa533fd5e797f401b64ff8c2ed7b7" }, "downloads": -1, "filename": "energyplus_wrapper-0.3-py3.6.egg", "has_sig": false, "md5_digest": "7e48e73e5209aefd0edbeb59cec36f4d", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 9181, "upload_time": "2017-02-18T13:26:39", "url": "https://files.pythonhosted.org/packages/2b/9d/6162d074a5c4c3c8511e22936b458bc039c6663d14f8b1b7d707cff1c886/energyplus_wrapper-0.3-py3.6.egg" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "affaccfb0ee5a0c2d69d824824d84339", "sha256": "b5e618c62638b70c998e0150b83a562ba065815bf17736d8382f7886e4e64dc6" }, "downloads": -1, "filename": "energyplus_wrapper-0.3.1-py2.7.egg", "has_sig": false, "md5_digest": "affaccfb0ee5a0c2d69d824824d84339", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 9218, "upload_time": "2017-02-18T13:36:16", "url": "https://files.pythonhosted.org/packages/14/41/5b45d290598d5bdbeb453a92cc0e7bd135669ee803f0b3ddbc25df339dfc/energyplus_wrapper-0.3.1-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "adfc083e37ea18748cdccf39174b2ec7", "sha256": "1809d49afb0e5c032d5c005e9848bc8cdba87b9155e8513502aa32b2b8719915" }, "downloads": -1, "filename": "energyplus_wrapper-0.3.1-py3.6.egg", "has_sig": false, "md5_digest": "adfc083e37ea18748cdccf39174b2ec7", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 9186, "upload_time": "2017-02-18T13:36:18", "url": "https://files.pythonhosted.org/packages/3e/d7/527d8b019bdfe0b9e82a49cbee25c65edc2cd2f066ebee78002fe0edec92/energyplus_wrapper-0.3.1-py3.6.egg" } ], "0.3.2": [ { "comment_text": "", "digests": { "md5": "fcd71fd2bb594b16816d0a859c5876a1", "sha256": "67cdd23dc885ee9045eefe733af99092e01329142288d26293184c5cb080ab1f" }, "downloads": -1, "filename": "energyplus_wrapper-0.3.2-py2.7.egg", "has_sig": false, "md5_digest": "fcd71fd2bb594b16816d0a859c5876a1", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 9218, "upload_time": "2017-02-18T13:37:37", "url": "https://files.pythonhosted.org/packages/f6/d2/ca48bc7cbb8292e8e215f398a3e3b7adda7fd8a178e2299a1996940b981a/energyplus_wrapper-0.3.2-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "b4cab2652c0d4ae00adfe55d2544c9c5", "sha256": "e17cd72e2012c214b8cfa6664953464c31a4277f65382c831ca06f2b4fe4a6fb" }, "downloads": -1, "filename": "energyplus_wrapper-0.3.2-py3.6.egg", "has_sig": false, "md5_digest": "b4cab2652c0d4ae00adfe55d2544c9c5", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 9186, "upload_time": "2017-02-18T13:37:39", "url": "https://files.pythonhosted.org/packages/21/61/8cdf9f2d7993614bcb4bd2760007e745b76163a96bc128ef8e22fa2d5cf2/energyplus_wrapper-0.3.2-py3.6.egg" } ], "0.3.3": [ { "comment_text": "", "digests": { "md5": "8a939c550fb7470d3804bf1f77ae38fc", "sha256": "1b9f6ed5af3188a2ec93ea64923648f58d0d9fdcf8ee41980d3ce9981502f314" }, "downloads": -1, "filename": "energyplus_wrapper-0.3.3-py2.7.egg", "has_sig": false, "md5_digest": "8a939c550fb7470d3804bf1f77ae38fc", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 9675, "upload_time": "2017-03-06T13:45:14", "url": "https://files.pythonhosted.org/packages/0b/e9/d2258ed37d6a0986c6a03271b192ce943fb283df7b2554a936478906f590/energyplus_wrapper-0.3.3-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "64f87b290328c80bca0cc4eff0255a0d", "sha256": "58a15eb9a62ae3549be4101fc1c1589ee8a1588349609f4acb9bf837ec5dc800" }, "downloads": -1, "filename": "energyplus_wrapper-0.3.3-py3.6.egg", "has_sig": false, "md5_digest": "64f87b290328c80bca0cc4eff0255a0d", "packagetype": "bdist_egg", "python_version": "3.6", "requires_python": null, "size": 9595, "upload_time": "2017-03-06T13:45:16", "url": "https://files.pythonhosted.org/packages/5c/9a/e250d63fc8f59e41f7989bc371b5280e339bcc14e0e59aec7a3c15b12241/energyplus_wrapper-0.3.3-py3.6.egg" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "61a1c72a606c94b427e270581027a9d4", "sha256": "a4415f41749c10209698a1d0c450cab0d921f7c35731ce5b91ba70338871500a" }, "downloads": -1, "filename": "energyplus_wrapper-0.4.0.tar.gz", "has_sig": false, "md5_digest": "61a1c72a606c94b427e270581027a9d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5089, "upload_time": "2017-05-29T14:57:30", "url": "https://files.pythonhosted.org/packages/96/43/6c95b2d6c33200d907f70ea71393e83fa07734f7bdc7b81e127c8228a092/energyplus_wrapper-0.4.0.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "e71f7d2482412c73da0da1a09b755ac0", "sha256": "3c3f07590e3649cea1942c0984805ceb7d7a3ae0f7f86338808c22c67874165e" }, "downloads": -1, "filename": "energyplus_wrapper-0.5.0.tar.gz", "has_sig": false, "md5_digest": "e71f7d2482412c73da0da1a09b755ac0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5256, "upload_time": "2017-05-30T16:23:17", "url": "https://files.pythonhosted.org/packages/a8/02/a06590aad299f0f084767c62fe0e4e20ab67c899254303b620825f60ca43/energyplus_wrapper-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "0af9c0c6092b01c5546b1ddf09a5c725", "sha256": "5918ae415effad8bc5499fe2231f1ab0cfc86d29f47476fc7a416e5acff563af" }, "downloads": -1, "filename": "energyplus_wrapper-0.5.1.tar.gz", "has_sig": false, "md5_digest": "0af9c0c6092b01c5546b1ddf09a5c725", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4370, "upload_time": "2018-04-09T15:37:48", "url": "https://files.pythonhosted.org/packages/bc/dc/4756b5cdc69fc38af88ab2bd86e9a652b79120d2796fa9d3458ec0a865cb/energyplus_wrapper-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "1e918be2b43844304e866794b0dbdc6f", "sha256": "594595e65e4e173b3bd3fe15df3dda0b1fc284c3af35309f4c68d32e1a8f0bc5" }, "downloads": -1, "filename": "energyplus_wrapper-0.5.2.tar.gz", "has_sig": false, "md5_digest": "1e918be2b43844304e866794b0dbdc6f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4564, "upload_time": "2018-04-25T15:50:37", "url": "https://files.pythonhosted.org/packages/a0/83/ee59c4cdb0b5b382a522b0111eda21189578b6c7283bdf8ebeb2a17391f7/energyplus_wrapper-0.5.2.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "eb40ec1a0f0ee4fdf3c6edb678103361", "sha256": "467343367dc5a9a64c6ff802a41611b77a625284d14b4448813e8ae52cc2a510" }, "downloads": -1, "filename": "energyplus_wrapper-0.6.0-py3-none-any.whl", "has_sig": false, "md5_digest": "eb40ec1a0f0ee4fdf3c6edb678103361", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 10284, "upload_time": "2018-06-11T13:47:31", "url": "https://files.pythonhosted.org/packages/45/ee/91020ef443b169239767f29c63d842295a3395db5bed9eed73b05a93b828/energyplus_wrapper-0.6.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6212529d921600e4f86eec5d40ea296e", "sha256": "8b38729fde07f031531eb095ac8b9e0c5ffeea4babcfbae9dbf44466577d8d15" }, "downloads": -1, "filename": "energyplus_wrapper-0.6.0.tar.gz", "has_sig": false, "md5_digest": "6212529d921600e4f86eec5d40ea296e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 3615, "upload_time": "2018-06-11T13:47:32", "url": "https://files.pythonhosted.org/packages/85/4c/6ada58b7782c9ffe881ced19ec50fef78ac34fd062db58ffafa839fffcdb/energyplus_wrapper-0.6.0.tar.gz" } ], "0.6.1": [ { "comment_text": "", "digests": { "md5": "9076211d043f030ba0b3d2963dd9464a", "sha256": "baf43144b119b45dfa971352b5a8f4bc21e905949e8b354a3f18c84c20e74335" }, "downloads": -1, "filename": "energyplus_wrapper-0.6.1-py3-none-any.whl", "has_sig": false, "md5_digest": "9076211d043f030ba0b3d2963dd9464a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5597, "upload_time": "2018-09-25T15:38:54", "url": "https://files.pythonhosted.org/packages/e4/28/5bf79d1a9b8a64e2e5362931bc9fec5bd5cd2df1457b8dff765b374ed6d8/energyplus_wrapper-0.6.1-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9076211d043f030ba0b3d2963dd9464a", "sha256": "baf43144b119b45dfa971352b5a8f4bc21e905949e8b354a3f18c84c20e74335" }, "downloads": -1, "filename": "energyplus_wrapper-0.6.1-py3-none-any.whl", "has_sig": false, "md5_digest": "9076211d043f030ba0b3d2963dd9464a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5597, "upload_time": "2018-09-25T15:38:54", "url": "https://files.pythonhosted.org/packages/e4/28/5bf79d1a9b8a64e2e5362931bc9fec5bd5cd2df1457b8dff765b374ed6d8/energyplus_wrapper-0.6.1-py3-none-any.whl" } ] }