witheppy 0.1.8
Python packages built using eppy
License: MIT license
Keywords: witheppy

========
witheppy
========


.. image:: https://img.shields.io/pypi/v/witheppy.svg
        :target: https://pypi.python.org/pypi/witheppy

.. image:: https://img.shields.io/travis/pyenergyplus/witheppy.svg
        :target: https://travis-ci.org/pyenergyplus/witheppy

.. image:: https://readthedocs.org/projects/witheppy/badge/?version=latest
        :target: https://witheppy.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status




Python packages built using eppy


* Free software: MIT license
* Documentation: https://witheppy.readthedocs.io.


Features
--------

* includes additional functionality that can be used with `eppy <https://github.com/santoshphilip/eppy>`_

What is witheppy
----------------

Witheppy is a python package that gathers all the useful functions written with eppy. Many people have used eppy and some have written functions that may be useful to practitioners at large. This becomes an organized place to upload this code.

More will be written on where to upload the code and how to document it. The functions will fall under multiple categories, such as idfhelpers, geometry, HVAC, JSON reader. 

The JSON reader may be the most critical functionality. E+ is transitioning towards using a JSON file format instead of the IDD/IDF text format. At one point all E+ files will be in the JSON format. Right now eppy cannot read the JSON format. The intent is to have JSON reader in witheppy for eppy.

Witheppy to eppy
----------------

Any code put into witheppy proves to be useful, it will be transitioned into eppy. To ensure that witheppy is working as intended, the maintainers of eppy will not write code directly into eppy. All code intended for eppy will be first written in witheppy and then if it proves to be useful, it will be transitioned into eppy.

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

=======
History
=======


Releases
--------

release 0.1.8
-------------

:Date:   Sun Dec 12 11:20:53 2021 -0800


- fixed issue #53
	- :Problem: Need guidance on how to do a release
	- :Solution: Steps for release are documented on CONTRIBUTIONS.rst

:Date:   Sat Dec 11 19:35:58 2021 -0800

- fixed issue #11
	- :Problem: CONTRIBUTIONS.rst page needs to use the C4 contract
	- :Solutions: CONTRIBUTIONS.rst page updated to list the steps in the C4 Contract
	
	

release 0.1.6
-------------

:Date:   Mon Dec 6 14:37:38 2021 -0800

- fixed issue #42
	- :Problem: Need a function to add or remove exhaust fans from a zone
	- :Solution: putexhaust(), removeexhaust(), hasexhaust(), findexhaust() in eppyhelpers.hvac

release 0.1.5
-------------

2021-12-04
~~~~~~~~~~

- fixed issue #39
	- :Problem: Need a function to merge 2 or more zones
	- :Solution: wrote eppyhelpers.mergezones(idf, mergeznames)


release 0.1.4
-------------

2021-01-25
~~~~~~~~~~

- fixed issue #32
	- :Problem: runandget get uses idf.run() which does not allow runs simultaneously
	- :Solution: use idfRUNs() which allows multiple runs simultaneously 

2021-01-22
~~~~~~~~~~

- fixed issue #30
	- :Problem: remove ephtml - this functionality is present in eppy
	- :Solution: removed ephtml- now using eppy.results.fasthtml


2021-01-01
~~~~~~~~~~

- fixed issue #27
    - **Problem:** experimental.runadget() was written in eppy. It should be in witheppy
    - **Solution:** moved runadget() to witheppy

2019-05-23
~~~~~~~~~~

- removed the optional arg weather from eplaunch
    - fix for issue #24


release 0.1.0
-------------

2018-10-15
~~~~~~~~~~

* First release on PyPI.