From 0b0f3cb2aca6ba013ef9b79282b44a9d4e886c0b Mon Sep 17 00:00:00 2001 From: Thierry Nouidui Date: Mon, 19 Sep 2016 16:02:06 -0700 Subject: [PATCH] Update documentation. --- .../www/userGuide/acknowledgments.html | 7 +-- .../userGuide/www/userGuide/bestPractice.html | 9 +-- .../userGuide/www/userGuide/build.html | 17 +++--- .../userGuide/www/userGuide/development.html | 7 +-- .../userGuide/www/userGuide/disclaimer.html | 7 +-- .../userGuide/www/userGuide/download.html | 57 +++++++++++------- .../userGuide/www/userGuide/genindex.html | 7 +-- .../userGuide/www/userGuide/glossary.html | 7 +-- .../userGuide/www/userGuide/help.html | 7 +-- .../userGuide/www/userGuide/index.html | 25 ++++---- .../userGuide/www/userGuide/installation.html | 15 ++--- .../userGuide/www/userGuide/introduction.html | 7 +-- .../userGuide/www/userGuide/legal.html | 7 +-- .../userGuide/www/userGuide/mathematics.html | 7 +-- .../userGuide/www/userGuide/notation.html | 7 +-- .../userGuide/www/userGuide/objects.inv | Bin 552 -> 720 bytes .../userGuide/www/userGuide/search.html | 4 +- .../userGuide/www/userGuide/searchindex.js | 2 +- .../userGuide/www/userGuide/usage.html | 7 +-- 19 files changed, 88 insertions(+), 118 deletions(-) diff --git a/Documentation/userGuide/www/userGuide/acknowledgments.html b/Documentation/userGuide/www/userGuide/acknowledgments.html index 9c969ad..7e5c682 100644 --- a/Documentation/userGuide/www/userGuide/acknowledgments.html +++ b/Documentation/userGuide/www/userGuide/acknowledgments.html @@ -14,7 +14,7 @@ @@ -131,7 +128,7 @@

Navigation

\ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/bestPractice.html b/Documentation/userGuide/www/userGuide/bestPractice.html index 778cf43..af9df3f 100644 --- a/Documentation/userGuide/www/userGuide/bestPractice.html +++ b/Documentation/userGuide/www/userGuide/bestPractice.html @@ -14,7 +14,7 @@ @@ -258,7 +255,7 @@

7.3. Configuring an EnergyPlus model which uses the Examples/Variable.

Please see the Input/Output reference of the EnergyPlus manual.

-

Please read Installation and Configuration to see how to generate an FMU.

+

Please read Installation and Configuration to see how to generate an FMU.

@@ -290,7 +287,7 @@

Navigation

\ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/build.html b/Documentation/userGuide/www/userGuide/build.html index 37d0029..2e49bd8 100644 --- a/Documentation/userGuide/www/userGuide/build.html +++ b/Documentation/userGuide/www/userGuide/build.html @@ -14,7 +14,7 @@ @@ -102,11 +99,11 @@

Quick search

4. Creating an FMU

This chapter describes how to create a Functional Mockup Unit, starting from an EnergyPlus IDF file. -It assumes you have followed the Installation and Configuration instructions, and that you have created an IDF file following the Best Practice guidelines.

+It assumes you have followed the Installation and Configuration instructions, and that you have created an IDF file following the Best Practice guidelines.

4.1. Command-line use

To create an FMU, -open a command-line window (see Notation). +open a command-line window (see Notation). The standard invocation of the EnergyPlusToFMU tool is:

> python  <path-to-scripts-subdir>EnergyPlusToFMU.py  -i <path-to-idd-file>  \
   -w <path-to-weather-file>  <path-to-idf-file>
@@ -122,7 +119,7 @@ 

4.1. Command-line usescriptDir is the path to the scripts directory of EnergyPlusToFMU. Typically this is the Scripts/ subdirectory of the installation directory. -See Installation and Configuration for details.

+See Installation and Configuration for details.

All file paths, including those to the weather, IDD, and IDF files, can be absolute or relative. For readability, the rest of these instructions omit the paths to the script and input files.

@@ -207,7 +204,7 @@

4.2. Outpututil-get-address-size.exe. This program is rebuilt every time you run the EnergyPlusToFMU tools (to ensure it uses the most recent compiler/linker batch files, as described -in Installation and Configuration). +in Installation and Configuration).
  • Build directories, named like bld-*.
  • A shared library, named like *.dll or *.so or *.dylib, depending on the system.
  • @@ -244,7 +241,7 @@

    4.3. TroubleshootingInstallation and Configuration.

    +Therefore you should check the configuration, according to the instructions in Installation and Configuration.

    If the export-preparation application runs, then try turning on option -d when running EnergyPlusToFMU.py. By announcing each major step before it is taken, this option helps to localize the problem.

    @@ -278,7 +275,7 @@

    Navigation

    \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/development.html b/Documentation/userGuide/www/userGuide/development.html index 9fe0514..c204da2 100644 --- a/Documentation/userGuide/www/userGuide/development.html +++ b/Documentation/userGuide/www/userGuide/development.html @@ -14,7 +14,7 @@
    @@ -124,7 +121,7 @@

    Navigation

    \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/disclaimer.html b/Documentation/userGuide/www/userGuide/disclaimer.html index 0bd0a4c..bd303a2 100644 --- a/Documentation/userGuide/www/userGuide/disclaimer.html +++ b/Documentation/userGuide/www/userGuide/disclaimer.html @@ -14,7 +14,7 @@
    @@ -134,7 +131,7 @@

    Navigation

    \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/download.html b/Documentation/userGuide/www/userGuide/download.html index 33ecc96..0de40d5 100644 --- a/Documentation/userGuide/www/userGuide/download.html +++ b/Documentation/userGuide/www/userGuide/download.html @@ -14,7 +14,7 @@ @@ -108,9 +107,23 @@

    Quick search

    2. Download

    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 Installation and Configuration.

    +

    To install EnergyPlusToFMU, follow the section Installation and Configuration.

    +
    +

    2.1. Release 2.0.2 (September 19, 2016)

    +

    Download 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 addresses issue#5 on github.

    +
    +
    +

    2.2. Release 2.0.1 (April 29, 2016)

    +

    Download 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 addresses issue#1 on github.

    +
    -

    2.1. Release 2.0.0 (April 14, 2016)

    +

    2.3. Release 2.0.0 (April 14, 2016)

    Download EnergyPlusToFMU-v2.0.0.zip.

    Release notes

    -

    2.3. Release 1.0.5 (May 26, 2015)

    +

    2.5. Release 1.0.5 (May 26, 2015)

    Download EnergyPlusToFMU-1.0.5.zip.

    Release notes

    This version fixes a memory leak.

    -

    2.4. Release 1.0.4 (April 27, 2015)

    +

    2.6. Release 1.0.4 (April 27, 2015)

    Download EnergyPlusToFMU-1.0.4.zip.

    Release notes

    This version fixes a bug that occurred when a large number of variables were exchanged with the EnergyPlus’s FMU.

    -

    2.5. Release 1.0.3 (May 23, 2014)

    +

    2.7. Release 1.0.3 (May 23, 2014)

    Download EnergyPlusToFMU-1.0.3.zip.

    Release notes

    This version contains a bug fix which was causing the EnergyPlus’s FMU to write an incorrect RunPeriod.

    -

    2.6. Release 1.0.2 (March 20, 2014)

    +

    2.8. Release 1.0.2 (March 20, 2014)

    Download EnergyPlusToFMU-1.0.2.zip.

    Release notes

    This version contains a bug fix which was causing a division by zero because of an invalid timeStep.

    -

    2.7. Release 1.0.1 (December 13, 2013)

    +

    2.9. Release 1.0.1 (December 13, 2013)

    Download EnergyPlusToFMU-1.0.1.zip.

    Release notes

    This version contains many improvements and bug fixes.

    -

    2.8. Release 1.0.0 (November 01, 2013)

    +

    2.10. Release 1.0.0 (November 01, 2013)

    Download EnergyPlusToFMU-1.0.0.zip.

    Release notes

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

    @@ -196,7 +209,7 @@

    Navigation

    \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/genindex.html b/Documentation/userGuide/www/userGuide/genindex.html index 65bfbba..6b58029 100644 --- a/Documentation/userGuide/www/userGuide/genindex.html +++ b/Documentation/userGuide/www/userGuide/genindex.html @@ -15,7 +15,7 @@ @@ -163,7 +160,7 @@

    Navigation

    \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/glossary.html b/Documentation/userGuide/www/userGuide/glossary.html index 4e27969..65de0be 100644 --- a/Documentation/userGuide/www/userGuide/glossary.html +++ b/Documentation/userGuide/www/userGuide/glossary.html @@ -14,7 +14,7 @@ @@ -147,7 +144,7 @@

    Navigation

    \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/help.html b/Documentation/userGuide/www/userGuide/help.html index a0d3f2c..f8cea11 100644 --- a/Documentation/userGuide/www/userGuide/help.html +++ b/Documentation/userGuide/www/userGuide/help.html @@ -14,7 +14,7 @@ @@ -142,7 +139,7 @@

    Navigation

    \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/index.html b/Documentation/userGuide/www/userGuide/index.html index 9dda8c9..0faecd4 100644 --- a/Documentation/userGuide/www/userGuide/index.html +++ b/Documentation/userGuide/www/userGuide/index.html @@ -14,7 +14,7 @@ @@ -88,14 +85,16 @@

    User Guide1. Introduction
  • 2. Download
  • 3. Installation and Configuration
      @@ -164,7 +163,7 @@

      Navigation

      \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/installation.html b/Documentation/userGuide/www/userGuide/installation.html index cbb2973..d2a4af8 100644 --- a/Documentation/userGuide/www/userGuide/installation.html +++ b/Documentation/userGuide/www/userGuide/installation.html @@ -14,7 +14,7 @@ @@ -131,7 +128,7 @@

      3.1. Software requirements

      3.2. Installation

      To install EnergyPlusToFMU, proceed as follows:

        -
      1. Download the installation file from the Download page.
      2. +
      3. Download the installation file from the Download page.
      4. Unzip the installation file into any subdirectory (hereafter referred to as the “installation directory”).

      The installation directory should contain the following subdirectories:

      @@ -160,7 +157,7 @@

      3.1. Software requirements

      3.3. Configuration

      EnergyPlusToFMU comes pre-configured to handle the most common system configurations. -Usually, you can simply create an FMU, as described in Creating an FMU, and everything will work.

      +Usually, you can simply create an FMU, as described in Creating an FMU, and everything will work.

      The remainder of this section provides tips for configuring EnergyPlusToFMU to match your particular system and needs. This may be needed in case problems arise. In addition, you may wish to reconfigure EnergyPlusToFMU, for example to optimize the FMU code, or to change the memory model under which it runs.

      @@ -251,7 +248,7 @@

      3.5. Running a basic testThe batch file test-c-exe.bat runs the appropriate compiler and linker batch files, and tests the resulting executable. It reports its progress, and so should give information as to where problems occur, if any.

      To run the basic test, -open a command-line window (see Notation). +open a command-line window (see Notation). Next, change to the appropriate batch file directory, and run the test batch file.

      A sample session at the Windows DOS prompt:

      # Change to the batch file directory.
      @@ -320,7 +317,7 @@ 

      3.6. Checking compile-c.batNotation). +

      To check the compiler batch file, open a command-line window (see Notation). Next, change to the appropriate batch file directory, and run the compiler batch file. The compiler should produce an object file in the same directory.

      A sample session at the Windows DOS prompt:

      @@ -584,7 +581,7 @@

      Navigation

      \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/introduction.html b/Documentation/userGuide/www/userGuide/introduction.html index 595f7d0..0c25d31 100644 --- a/Documentation/userGuide/www/userGuide/introduction.html +++ b/Documentation/userGuide/www/userGuide/introduction.html @@ -14,7 +14,7 @@
      @@ -126,7 +123,7 @@

      Navigation

      \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/legal.html b/Documentation/userGuide/www/userGuide/legal.html index 8e214ce..fdc09a4 100644 --- a/Documentation/userGuide/www/userGuide/legal.html +++ b/Documentation/userGuide/www/userGuide/legal.html @@ -14,7 +14,7 @@ @@ -132,7 +129,7 @@

      Navigation

      \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/mathematics.html b/Documentation/userGuide/www/userGuide/mathematics.html index 489a832..d641761 100644 --- a/Documentation/userGuide/www/userGuide/mathematics.html +++ b/Documentation/userGuide/www/userGuide/mathematics.html @@ -14,7 +14,7 @@ @@ -168,7 +165,7 @@

      Navigation

      \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/notation.html b/Documentation/userGuide/www/userGuide/notation.html index c966a26..e80868a 100644 --- a/Documentation/userGuide/www/userGuide/notation.html +++ b/Documentation/userGuide/www/userGuide/notation.html @@ -14,7 +14,7 @@ @@ -138,7 +135,7 @@

      Navigation

      \ No newline at end of file diff --git a/Documentation/userGuide/www/userGuide/objects.inv b/Documentation/userGuide/www/userGuide/objects.inv index d4751c3ebba131f48c0d8d914ef0eadab086d4e8..faccce83e418d5920eea4c47ef6fc70b18ee53c5 100644 GIT binary patch delta 593 zcmV-X0i9+ZBRz?%+~v&1_7fon$UYeLJdx2@|W`B;M0Jy>@zlsUm5 z7w5QFenNyS(5&loouv05&njPCt+j)Yya<~BpK@b>I-wdu6@U49cg(mcAhOYU&FAn3 zr0%EY@`McbIiC}-(Zr;+3iAq`uuM|XfhnRQ8j|ALR$MD&SVFso4AeC)>1Qi?u6D?q^?farR8906Aucv-|cU|-`^e-p0QR`l1{USdgzHz z7=5DQn(P#pw10Kb)=7KTdQigshwCh>s|J)%9G=RC7Stcd_vvr7*yhJpM3LLDs#=hJ zPMg-A@(ur0DKPA3Sx1W(>2?qtkY*i~l1_z}?1V1`W=yI$xzXw*n!(J-)+qM5vBLBF z7c(vlFsH*q*|E)$I;rw3baqDbfo=Ou_|k7ewz8~@m49&VE|W@V@FHbVGZ1Ew?nfh< z*3Hl02aYUdq3Wn>0e=K5rfdd#^<4z$G-fO_qMswz2C>++1=jk!iRK^?z2r^zT->;j zeCBQF$9mZa-Qg3I5Z()=-R6oen5X{?tCAY+3o^DH>HT=>#3g0-qicif3rq{tu(r(i zm@oC0-%3B=Jge}c4EGXjtM&YG>Cr@3iI_tk#^27mWVs+Ty# delta 424 zcmV;Z0ayOe1*im&ihop1Ps1P>zVj>lyzl}USf>rm9nS$<$6f@@Kwz@QSzr#4d8}M5?pF9UU^sy&^IWhCQwt^a z#sGC(mY7QXzCR)cKOmH@LAt4HL?rKafDlu^QYd;cRYK2>IDba0sgiRII0w-qP~C)<8ck)6dJamtmWfqypC}|0Z5zF2mFXjXS+i+~6hAO9t<3 zw3podBek;;RD$G^!D+gng!U15*Zw0et)oKFHfSmzGie)kV>OiwZwIL9Df0X?6fVw-paIKFWuL}Go S!IaHGc#Ek`58NMndE)(lNYKUr diff --git a/Documentation/userGuide/www/userGuide/search.html b/Documentation/userGuide/www/userGuide/search.html index 4ebc296..0b62746 100644 --- a/Documentation/userGuide/www/userGuide/search.html +++ b/Documentation/userGuide/www/userGuide/search.html @@ -14,7 +14,7 @@ @@ -204,7 +201,7 @@

      Navigation

      \ No newline at end of file