Skip to content

Commit

Permalink
Remove most references to helpserve from the readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Myoldmopar
Myoldmopar committed Sep 22, 2021
1 parent dc8bb4d commit 18eed1f
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 47 deletions.
8 changes: 5 additions & 3 deletions doc/essentials/src/essentials.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ \section{Getting Help \label{subsec:Getting-Help}}
Several resources are available for getting help when using EnergyPlus:
\begin{itemize}
\item \href{https://unmethours.com/questions/}{UnmetHours}
\item \href{http://energyplus.helpserve.com/}{EnergyPlus Helpdesk}
\item \href{https://energyplushelp.freshdesk.com/}{EnergyPlus Helpdesk}
\item \href{https://groups.yahoo.com/neo/groups/EnergyPlus_Support/info}{EnergyPlus\_support mailing list}
\item \href{https://buildingenergysoftwaretools.com/?capabilities=Support+Services&keys=EnergyPlus}{Several organizations provide paid support}
\end{itemize}
Expand Down Expand Up @@ -750,8 +750,10 @@ \section{Creating and Editing Input Files}
a good text editor is an important application to have when working
with EnergyPlus. There are many different \href{https://en.wikipedia.org/wiki/Comparison_of_text_editors}{text editors},
and a few have special features related to the IDF format such as
syntax highlighting including \href{https://github.com/bigladder/atom-language-energyplus}{Atom},
\href{https://github.com/jmarrec/notepad}{Notepad++}, and \href{http://energyplus.helpserve.com/knowledgebase/article/View/102/47/ultraedit-syntax-highlighting-file---v80}{UltraEdit}.
syntax highlighting including \href{https://github.com/bigladder/atom-language-energyplus}{Atom} and
\href{https://github.com/jmarrec/notepad}{Notepad++}
%and \href{http://energyplus.helpserve.com/knowledgebase/article/View/102/47/ultraedit-syntax-highlighting-file---v80}{UltraEdit}.
Another editing choice for IDF file is the IDF Editor which comes
with EnergyPlus in the \textbackslash PreProcess\textbackslash IDFEditor
Expand Down
2 changes: 1 addition & 1 deletion doc/tips-and-tricks-using-energyplus/src/introduction-support/energyplus-support.tex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ \section{EnergyPlus Support}\label{energyplus-support}

\textbf{Please refer to the Support page for up to date information}: \url{https://energyplus.net/support}

The primary EnergyPlus support site is supplied at: \url{http://energyplus.helpserve.com}
The primary EnergyPlus support site is supplied at: \url{https://energyplushelp.freshdesk.com/}

The site is monitored by EnergyPlus developers and questions are attempted to be answered in a timely manner. Standard EnergyPlus support is provided free of charge by the U.S. Deparment of Energy, as part of a continuing effort to improve the EnergyPlus building simulation tool. Expedited, priority support may be available from other sources. The helpdesk has a files area where important (after release) files may be put as well as the storage for the Transition file set that are prior to the current release.
101 changes: 58 additions & 43 deletions release/readme.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ <h1><img src="favicon.png" alt="EnergyPlus Logo" width="98" height="98"> EnergyP
<div class="col-md-2"></div>
<div class="col-md-8 text-center">
EnergyPlus is a simulation program designed for modeling buildings with all their associated
heating, cooling, lighting, ventilating, and other energy flows. EnergyPlus is a stand-alone simulation engine
without a ‘user friendly’ graphical interface. EnergyPlus reads input and writes output as text files,
heating, cooling, lighting, ventilating, and other energy flows. EnergyPlus is a stand-alone simulation
engine
without a ‘user friendly’ graphical interface. EnergyPlus reads input and writes output as text files,
although as of 9.3, EnergyPlus started becoming a library.
</div>
<div class="col-md-2"></div>
Expand Down Expand Up @@ -82,19 +83,19 @@ <h2>Using EnergyPlus</h2>
this website for third party interfaces</a>. A completely new cross-platform version of EP-Launch has been
developed and is available separate from the EnergyPlus install; see the <a
href="https://ep-launch.readthedocs.io/en/latest/intro.html#ep-launch">documentation</a> for more
information. Some tools may produce out of date IDF files; you can then use the IDFVersionUpdater program to
information. Some tools may produce out of date IDF files; you can then use the IDFVersionUpdater program to
convert older files to current EnergyPlus version (you may need to use the Multiple Version Conversions
set – see below).
</p>

<h2>* Future Version Numbers *</h2>
<p>
EnergyPlus has historically used version numbers that sometimes varied the major number and sometimes the minor
number. For the last 17 releases we have just incremented the minor number and we are now at 9.6. Since
number. For the last 17 releases we have just incremented the minor number and we are now at 9.6. Since
EnergyPlus input files have some breaking changes in each release, the minor number change does not hold a
lot of meaning. We have decided to move forward with a more modern version numbering scheme starting next year.
The EnergyPlus version will be based on the year and the release number. The March release is expected to be
EnergyPlus 2022.1 and the Fall release will be EnergyPlus 2022.2. If additional major releases are created for
lot of meaning. We have decided to move forward with a more modern version numbering scheme starting next year.
The EnergyPlus version will be based on the year and the release number. The March release is expected to be
EnergyPlus 2022.1 and the Fall release will be EnergyPlus 2022.2. If additional major releases are created for
some reason, they would increment the release number further.
</p>

Expand All @@ -110,18 +111,18 @@ <h2><a id="Whats_going_on"></a>What’s going on in V9.6?</h2>
<div class="card card-body">
<h5 class="card-title">Yes... and no.</h5>
<p class="card-text">
Put a pin in that library question for a moment. For a majority of users, EnergyPlus is still
Put a pin in that library question for a moment. For a majority of users, EnergyPlus is still
basically the same tool, but with some great new features, bug fixes, and runtime performance
improvements. Running EnergyPlus can still be accomplished the same way, by creating an input
improvements. Running EnergyPlus can still be accomplished the same way, by creating an input
file in IDF or EpJSON syntax, running the EnergyPlus(.exe) binary, and gathering results of
interest. All this power is still available. &#128077; <br>
interest. All this power is still available. &#128077; <br>
As of EnergyPlus 9.3, EnergyPlus started becoming a bit more flexible thanks to the addition of
a formal C API with Python Bindings, as well as the ability to execute user-defined Python
"plugins" in lieu of writing user-defined Erl code. In the library mode, a
"plugins" in lieu of writing user-defined Erl code. In the library mode, a
client can make function calls to setup and execute a simulation, as well as interact with
simulation results <b>during</b> a simulation. &#128077; &#128077; &#128077;<br>
A key effort completed with 9.5 was making EnergyPlus "thread-safe" by removing all global and
static data from the program. Now each running thread of EnergyPlus has a complete simulation
static data from the program. Now each running thread of EnergyPlus has a complete simulation
state, and no data is shared, so multiple runs can happen within a single process, opening the
door for interesting new workflows and applications.<br>
See the full
Expand All @@ -143,8 +144,9 @@ <h5 class="card-title">Yes... and no.</h5>
<div class="collapse" id="collapseIDDIDF">
<div class="card card-body">
<h5 class="card-title">No, they are different</h5>
<p class="card-text">There are a few key changes in the V9.5 IDD. For best results, use the transition program to
transfer from the earlier V9.4 files. Use the IDFVersionUpdater program for best results.</p>
<p class="card-text">There are a few key changes in the V9.5 IDD. For best results, use the
transition program to
transfer from the earlier V9.4 files. Use the IDFVersionUpdater program for best results.</p>
</div>
</div>
</div>
Expand All @@ -161,27 +163,37 @@ <h5 class="card-title">No, they are different</h5>
<div class="card card-body">
<h5 class="card-title">Some objects require transition</h5>
There have been changes in the following objects which require conversion. Either read and follow
the Rules document or use the IDFVersionUpdater utility. The “Rules” document contains information on
exact object changes that you can do by hand. The updater program is described more fully in the Auxiliary
the Rules document or use the IDFVersionUpdater utility. The “Rules” document contains information
on
exact object changes that you can do by hand. The updater program is described more fully in the
Auxiliary
Programs document. For the v9.5 release, the following objects require conversion (from V9.4):
<ul class="list-group">
<li class="list-group-item transition-object-name">Construction:AirBoundary</li>
<li class="list-group-item transition-object-name">Coil:Cooling:WaterToAirHeatPump:EquationFit</li>
<li class="list-group-item transition-object-name">Coil:Heating:WaterToAirHeatPump:EquationFit</li>
<li class="list-group-item transition-object-name">Coil:Cooling:WaterToAirHeatPump:EquationFit
</li>
<li class="list-group-item transition-object-name">Coil:Heating:WaterToAirHeatPump:EquationFit
</li>
<li class="list-group-item transition-object-name">Construction:InternalSource</li>
<li class="list-group-item transition-object-name">HeatPump:WaterToWater:EquationFit:Cooling</li>
<li class="list-group-item transition-object-name">HeatPump:WaterToWater:EquationFit:Heating</li>
<li class="list-group-item transition-object-name">HeatPump:WaterToWater:EquationFit:Cooling
</li>
<li class="list-group-item transition-object-name">HeatPump:WaterToWater:EquationFit:Heating
</li>
<li class="list-group-item transition-object-name">ZoneAirMassFlowConservation</li>
<li class="list-group-item transition-object-name">ZoneHVAC:LowTemperatureRadiant:VariableFlow</li>
<li class="list-group-item transition-object-name">ZoneHVAC:LowTemperatureRadiant:ConstantFlow</li>
<li class="list-group-item transition-object-name">ZoneHVAC:Baseboard:RadiantConvective:Water</li>
<li class="list-group-item transition-object-name">ZoneHVAC:Baseboard:RadiantConvective:Steam</li>
<li class="list-group-item transition-object-name">ZoneHVAC:LowTemperatureRadiant:VariableFlow
</li>
<li class="list-group-item transition-object-name">ZoneHVAC:LowTemperatureRadiant:ConstantFlow
</li>
<li class="list-group-item transition-object-name">ZoneHVAC:Baseboard:RadiantConvective:Water
</li>
<li class="list-group-item transition-object-name">ZoneHVAC:Baseboard:RadiantConvective:Steam
</li>
</ul>
</div>
</div>
</div>
</div>

<div class="row">
<div class="col-md-12">
<a class="btn btn-primary margin-bottom-6" data-toggle="collapse" href="#collapseInputCheck" role="button"
Expand All @@ -204,7 +216,7 @@ <h2><a id="Multiple_Version_Conversions_51"></a>Multiple Version Conversions</h2
<p>
The install includes the IDFVersionUpdater program and the necessary programs to convert from the previous
version (including .rvi and .mvi files) to the current version. The install also includes the necessary programs
to convert from older versions back to v7.2.0. For versions older than v7.2.0, first we applaud your dedication
to convert from older versions back to v7.2.0. For versions older than v7.2.0, first we applaud your dedication
to EnergyPlus that stretches for quite some time, and second you will need to visit the
helpdesk and download the multiple conversion set of programs. The helpdesk downloads area:
<a href="http://energyplus.helpserve.com/Knowledgebase/List/Index/46/converting-older-version-files">
Expand All @@ -229,7 +241,7 @@ <h2><a id="Documentation_55"></a>Documentation</h2>
Reports</a>
</div>
<p>
In addition, we are working to make our API documentation dynamic and hosted on ReadTheDocs. The
In addition, we are working to make our API documentation dynamic and hosted on ReadTheDocs. The
<a href="https://github.com/NREL/EnergyPlus/blob/develop/README.md">README</a> on our Github Repo will be kept
up to date with links to our documentation sources as we get things settled there.
</p>
Expand All @@ -251,7 +263,9 @@ <h3><a id="Highlights_of_this_release"></a>New Features</h3>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/8327">8327</a></td>
<td>Expand access for ancillary power inputs and total electricity rate/energy to all coil types in UnitarySystem</td>
<td>Expand access for ancillary power inputs and total electricity rate/energy to all coil types in
UnitarySystem
</td>
</tr>
<tr>
<td><a href="https://github.com/NREL/EnergyPlus/pull/8405">8405</a></td>
Expand Down Expand Up @@ -342,7 +356,8 @@ <h3><a id="RefactoringEfforts"></a>Targeted Refactoring Efforts</h3>
<div class="col-md-10">
<blockquote class="blockquote text-center">
<p class="mb-0">
The changelog is no longer packaged with EnergyPlus, but can be found on the <a href="https://github.com/NREL/EnergyPlus/releases/latest">release page</a>.
The changelog is no longer packaged with EnergyPlus, but can be found on the <a
href="https://github.com/NREL/EnergyPlus/releases/latest">release page</a>.
</p>
</blockquote>
</div>
Expand All @@ -353,10 +368,10 @@ <h2><a id="Platforms_90"></a>Platforms</h2>
<p>
Packages changed slightly with the previous release (9.4).
We began building our packages on a new system which adds better support
for newer platforms. During the change, we stepped away from some older OS versions. For example, we are
not testing on Windows 7 or 8, only 10. However, both our 32-bit and 64-bit packages now include the new
Python plugin system, rather than just the 64-bit as previously. We have also added packaging and testing
with Ubuntu 20.04 <i>in addition to</i> Ubuntu 18.04. On Mac, we are officially releasing an installer for
for newer platforms. During the change, we stepped away from some older OS versions. For example, we are
not testing on Windows 7 or 8, only 10. However, both our 32-bit and 64-bit packages now include the new
Python plugin system, rather than just the 64-bit as previously. We have also added packaging and testing
with Ubuntu 20.04 <i>in addition to</i> Ubuntu 18.04. On Mac, we are officially releasing an installer for
OSX 10.15.
</p>
<ul class="list-group">
Expand Down Expand Up @@ -391,29 +406,29 @@ <h2>Additional steps you may want to consider:</h2>
files or your files.</p>
</li>
<li>
<p>The <a href="https://unmethours.com/questions/">UnmetHours</a> forum allows users to search for answers,
<p>The <a href="https://unmethours.com/questions/">UnmetHours</a> forum allows users to search for answers,
ask new questions about
their building simulation models to other users, and generally get quick feedback. Members of the
EnergyPlus
development team are also on the forum answering when possible.
</p>
</li>
<li>
<p>The EnergyPlus helpdesk (<a href="http://energyplus.helpserve.com">energyplus.helpserve.com</a>)
<p>The EnergyPlus helpdesk (<a href="https://energyplushelp.freshdesk.com/">energyplushelp.freshdesk.com</a>)
requires a login via self-registration or via sending a problem/question to the
email address
<a href="mailto:EnergyPlus-Support@gard.com">EnergyPlus-Support@gard.com</a>. In addition to having
support tickets and responses from helpdesk personnel, there are knowledgebase articles and a download area.</p>
</li> <li>
<p>BLDG-SIM: A free e-mail list for all building energy simulation program users to ask general building simulation questions to other
users and to post announcements (for events, training, job postings, etc.).
email address <a href="mailto:EnergyPlus-Support@gard.com">EnergyPlus-Support@gard.com</a>. In addition
to having support tickets and responses from helpdesk personnel, there are knowledgebase articles.</p>
</li>
<li>
<p>BLDG-SIM: A free e-mail list for all building energy simulation program users to ask general building
simulation questions to other
users and to post announcements (for events, training, job postings, etc.).
See <a href="http://lists.onebuilding.org/listinfo.cgi/bldg-sim-onebuilding.org">lists.onebuilding.org/listinfo.cgi/bldg-sim-onebuilding.org</a>
for information on joining this email list.</p>
</li>
<li>
<p>Open-Source License (or distribution license): Licenses for the source code and distribution are
available
from the website: <a href="https://energyplus.net/licensing">Licensing Info</a></p>
available from the website: <a href="https://energyplus.net/licensing">Licensing Info</a></p>
</li>
</ol>

Expand Down

0 comments on commit 18eed1f

Please # to comment.