Skip to content

Commit

Permalink
Merge pull request #27 from lbl-srg/issue4_idd
Browse files Browse the repository at this point in the history
Issue4 idd
  • Loading branch information
tsnouidui authored Jan 26, 2019
2 parents 60a426e + 671cdb1 commit befd794
Show file tree
Hide file tree
Showing 40 changed files with 2,184 additions and 1,482 deletions.
4 changes: 2 additions & 2 deletions Documentation/userGuide/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

release-html:
#-mkdir release
#-mkdir release/userGuide
Expand All @@ -101,7 +101,7 @@ release-html:
-cp -R $(BUILDDIR)/html/_images www/userGuide
-cp -R $(BUILDDIR)/html/legal.html ../../

dist: clean cleanpdf latex html release-html copypdftodoc copydoctowww
dist: clean cleanpdf latex html release-html copypdftodoc copydoctowww

copypdftodoc:
@echo "Copy pdf files to the userGuide folder."
Expand Down
9 changes: 4 additions & 5 deletions Documentation/userGuide/source/acknowledgments.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
Acknowledgments
===============

The development of this documentation was supported
by the Assistant Secretary for Energy Efficiency and Renewable Energy,
Office of Building Technologies of the U.S. Department of Energy,
The development of this documentation was supported
by the Assistant Secretary for Energy Efficiency and Renewable Energy,
Office of Building Technologies of the U.S. Department of Energy,
under contract No. DE-AC02-05CH11231.

The following people contributed to the development of this program:

- Thierry Stephane Nouidui, Lawrence Berkeley National Laboratory
- Thierry Stephane Nouidui, The United African University of Tanzania
- David M. Lorenzetti, Lawrence Berkeley National Laboratory
- Michael Wetter, Lawrence Berkeley National Laboratory

8 changes: 5 additions & 3 deletions Documentation/userGuide/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
#extensions = ['sphinx.ext.autodoc', 'sphinx.ext.pngmath']
extensions = ['sphinx.ext.autodoc', 'mathjax']
extensions = ['sphinxcontrib.bibtex', \
'sphinx.ext.autodoc', \
'sphinx.ext.mathjax', \
'sphinxcontrib.plantuml', 'sphinx.ext.todo']
# mathjax_path is based on http://www.mathjax.org/docs/2.0/start.html
mathjax_path = "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

Expand All @@ -51,7 +53,7 @@
# The short X.Y version.
version = '0.0'
# The full version, including alpha/beta/rc tags.
release = '2.0.3'
release = '2.1.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
45 changes: 27 additions & 18 deletions Documentation/userGuide/source/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,48 +5,58 @@
Download
========

The EnergyPlusToFMU release includes scripts and source code to export
The EnergyPlusToFMU release includes scripts and source code to export
EnergyPlus version 8.0 or higher as an FMU for co-simulation for Windows 32/64 bit, Linux 32/64 bit, and MAC OS X 64 bit.

To install EnergyPlusToFMU, follow the section :doc:`installation`.
To install EnergyPlusToFMU, follow the section :doc:`installation`.

Release 2.1.0 (January 26, 2019)
---------------------------------

Download `EnergyPlusToFMU-v2.1.0.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.1.0/EnergyPlusToFMU-v2.1.0.zip>`_.

**Release notes**

This version is a major release which adds supports for EnergyPlus version 9.0 and higher.
This release addresses `issue#24 <https://github.com/lbl-srg/EnergyPlusToFMU/issues/24/>`_ on github.

Release 2.0.3 (April 26, 2018)
------------------------------

Download `EnergyPlusToFMU-v2.0.3.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.3/EnergyPlusToFMU-v2.0.3.zip>`_.
Download `EnergyPlusToFMU-v2.0.3.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.3/EnergyPlusToFMU-v2.0.3.zip>`_.

**Release notes**

This version includes enhancements to support the use of EnergyPlus FMU with toolboxes such as `MPCPy <https://github.com/lbl-srg/MPCPy>`_.
This version includes enhancements to support the use of EnergyPlus FMU with toolboxes such as `MPCPy <https://github.com/lbl-srg/MPCPy>`_.

Release 2.0.2 (September 19, 2016)
----------------------------------

Download `EnergyPlusToFMU-v2.0.2.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.2/EnergyPlusToFMU-v2.0.2.zip>`_.
Download `EnergyPlusToFMU-v2.0.2.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.2/EnergyPlusToFMU-v2.0.2.zip>`_.

**Release notes**

This version fixes a bug which was causing an incorrect simulation stop time in the EnergyPlus's FMU.
This version fixes a bug which was causing an incorrect simulation stop time in the EnergyPlus's FMU.
This addresses `issue#5 <https://github.com/lbl-srg/EnergyPlusToFMU/issues/5/>`_ on github.

Release 2.0.1 (April 29, 2016)
------------------------------

Download `EnergyPlusToFMU-v2.0.1.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.1/EnergyPlusToFMU-v2.0.1.zip>`_.
Download `EnergyPlusToFMU-v2.0.1.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.1/EnergyPlusToFMU-v2.0.1.zip>`_.

**Release notes**

This version fixes a bug which was causing an incorrect simulation start time in the EnergyPlus's FMU.
This version fixes a bug which was causing an incorrect simulation start time in the EnergyPlus's FMU.
This addresses `issue#1 <https://github.com/lbl-srg/EnergyPlusToFMU/issues/1/>`_ on github.

Release 2.0.0 (April 14, 2016)
------------------------------

Download `EnergyPlusToFMU-v2.0.0.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.0/EnergyPlusToFMU-v2.0.0.zip>`_.
Download `EnergyPlusToFMU-v2.0.0.zip <https://github.com/lbl-srg/EnergyplusToFMU/releases/download/v2.0.0/EnergyPlusToFMU-v2.0.0.zip>`_.

**Release notes**

* This version is a major release which supports EnergyPlus 8.5.0 and higher. This version uses the `energyplus` command line interface to call EnergyPlus. Details about the interface can be found at https://github.com/NREL/EnergyPlus/blob/develop/doc/running-energyplus-from-command-line.md.
* This version is a major release which supports EnergyPlus 8.5.0 and higher. This version uses the `energyplus` command line interface to call EnergyPlus. Details about the interface can be found at https://github.com/NREL/EnergyPlus/blob/develop/doc/running-energyplus-from-command-line.md.

.. note:: As a result, this version might not be compatible with earlier versions of EnergyPlus. This is because legacy EnergyPlus scripts such as `RunEPlus.bat` and `runenergyplus` were deprecated as of August 2015.

Expand All @@ -55,7 +65,7 @@ Download `EnergyPlusToFMU-v2.0.0.zip <https://github.com/lbl-srg/EnergyplusToFMU
Release 1.0.6 (March 09, 2016)
------------------------------

Download `EnergyPlusToFMU-1.0.6.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.6/EnergyPlusToFMU-1.0.6.zip>`_.
Download `EnergyPlusToFMU-1.0.6.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.6/EnergyPlusToFMU-1.0.6.zip>`_.

**Release notes**

Expand All @@ -65,7 +75,7 @@ This version improves the compliance of the Energyplus's FMU to the FMI 1.0 spec
Release 1.0.5 (May 26, 2015)
------------------------------

Download `EnergyPlusToFMU-1.0.5.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.5/EnergyPlusToFMU-1.0.5.zip>`_.
Download `EnergyPlusToFMU-1.0.5.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.5/EnergyPlusToFMU-1.0.5.zip>`_.

**Release notes**

Expand All @@ -74,7 +84,7 @@ This version fixes a memory leak.
Release 1.0.4 (April 27, 2015)
------------------------------

Download `EnergyPlusToFMU-1.0.4.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.4/EnergyPlusToFMU-1.0.4.zip>`_.
Download `EnergyPlusToFMU-1.0.4.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.4/EnergyPlusToFMU-1.0.4.zip>`_.

**Release notes**

Expand All @@ -83,7 +93,7 @@ This version fixes a bug that occurred when a large number of variables were exc
Release 1.0.3 (May 23, 2014)
---------------------------------

Download `EnergyPlusToFMU-1.0.3.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.3/EnergyPlusToFMU-1.0.3.zip>`_.
Download `EnergyPlusToFMU-1.0.3.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.3/EnergyPlusToFMU-1.0.3.zip>`_.

**Release notes**

Expand All @@ -93,7 +103,7 @@ This version contains a bug fix which was causing the EnergyPlus's FMU to write
Release 1.0.2 (March 20, 2014)
---------------------------------

Download `EnergyPlusToFMU-1.0.2.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.2/EnergyPlusToFMU-1.0.2.zip>`_.
Download `EnergyPlusToFMU-1.0.2.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.2/EnergyPlusToFMU-1.0.2.zip>`_.

**Release notes**

Expand All @@ -103,7 +113,7 @@ This version contains a bug fix which was causing a division by zero because of
Release 1.0.1 (December 13, 2013)
---------------------------------

Download `EnergyPlusToFMU-1.0.1.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.1/EnergyPlusToFMU-1.0.1.zip>`_.
Download `EnergyPlusToFMU-1.0.1.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.1/EnergyPlusToFMU-1.0.1.zip>`_.

**Release notes**

Expand All @@ -113,9 +123,8 @@ This version contains many improvements and bug fixes.
Release 1.0.0 (November 01, 2013)
---------------------------------

Download `EnergyPlusToFMU-1.0.0.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.0/EnergyPlusToFMU-1.0.0.zip>`_.
Download `EnergyPlusToFMU-1.0.0.zip <http://simulationresearch.lbl.gov/fmu/EnergyPlus/export/releases/1.0.0/EnergyPlusToFMU-1.0.0.zip>`_.

**Release notes**

First release that uses FMI version 1.0 for co-simulation.

31 changes: 15 additions & 16 deletions Documentation/userGuide/source/legal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,31 @@ Copyright and License
=====================


Functional Mock-up Unit Export of EnergyPlus 2018, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Department of Energy). All rights reserved.
Functional Mock-up Unit Export of EnergyPlus 2019, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Department of Energy). All rights reserved.

If you have questions about your rights to use or distribute this software, please contact Berkeley Lab's Technology Transfer Department at [email protected]. referring to "Functional Mock-up Unit Export of EnergyPlus (LBNL Ref 2013-088)".

NOTICE: This software was produced by The Regents of the University of California under Contract No. DE-AC02-05CH11231 with the Department of Energy.
For 5 years from November 1, 2012, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. There is provision for the possible extension of the term of this license.
For 5 years from November 1, 2012, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, and perform publicly and display publicly, by or on behalf of the Government. There is provision for the possible extension of the term of this license.
Subsequent to that period or any extension granted, the Government is granted for itself and others acting on its behalf a nonexclusive, paid-up, irrevocable worldwide license in this data to reproduce, prepare derivative works, distribute copies to the public, perform publicly and display publicly, and to permit others to do so. The specific term of the license can be identified by inquiry made to Lawrence Berkeley National Laboratory or DOE. Neither the United States nor the United States Department of Energy, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any data, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights.
Copyright (c) 2018, The Regents of the University of California, Department of Energy contract-operators of the Lawrence Berkeley National Laboratory.


Copyright (c) 2019, The Regents of the University of California, Department of Energy contract-operators of the Lawrence Berkeley National Laboratory.
All rights reserved.

1. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

(1) Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer.

(2) Redistributions in binary form must reproduce the copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

(3) Neither the name of the University of California, Lawrence Berkeley National Laboratory, U.S. Dept. of Energy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

3. You are under no obligation whatsoever to provide any bug fixes, patches, or upgrades to the features, functionality or performance of the source code
("Enhancements") to anyone; however, if you choose to make your Enhancements available either publicly, or directly to Lawrence Berkeley National Laboratory, without imposing a separate written license agreement for such Enhancements, then you hereby grant the following license: a non-exclusive, royalty-free perpetual license to install, use, modify, prepare derivative works, incorporate into other computer software, distribute, and sublicense such enhancements or derivative works thereof, in binary and source code form.

NOTE: This license corresponds to the "revised BSD" or "3-clause BSD"
License and includes the following modification: Paragraph 3. has been added.

NOTE: This license corresponds to the "revised BSD" or "3-clause BSD"
License and includes the following modification: Paragraph 3. has been added.
Loading

0 comments on commit befd794

Please sign in to comment.