Skip to content

Commit

Permalink
Add docs related to new desktop shortcut
Browse files Browse the repository at this point in the history
  • Loading branch information
Myoldmopar committed Oct 26, 2022
1 parent c4ee79f commit 85a7dcd
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
3 changes: 2 additions & 1 deletion docs/forms/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ The program begins with the main form:

The form is laid out pretty simply, with a list of available component types in the left tree, a set of controls in
the middle, and a set of output windows on the right. The Help menu has options to open the online documentation in
a browser, as well as opening the example data folder that is packaged with the tool.
a browser, as well as opening the example data folder that is packaged with the tool. A newer addition to the menu is
also the capability to generate a shortcut icon on the system's desktop to make it very easy to launch the program.

To continue to generate parameters, the first step is to select a valid equipment type entry in the left tree, and
clicking the *Engage Equipment Type* button. Clicking this with an invalid entry in the tree will emit a dialog.
Expand Down
9 changes: 6 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,12 @@ Installation

This program should be installed from PyPi using ``pip install energyplus_pet``.
Once installed, a new command will be available from that Python environment called ``energyplus_pet_gui``, with a
``.exe`` appended on Windows. A future version of this tool will add an optional process to make it available from
a desktop icon. In the meantime, you are welcome to create a desktop link manually on the operating system of your
choice.
``.exe`` appended on Windows. Run this one time right from the command line where ``pip`` was executed to launch the
program. For easier access, there is an option in the top menu that allows creating a desktop icon. After that is
performed, the user can just launch the program right from the desktop icon.

To get updates to the program, you simply need to install the latest version using the same ``pip`` version, but let
``pip`` know that it can upgrade existing package installations: ``pip install --upgrade energyplus_pet``

Developing
----------
Expand Down

0 comments on commit 85a7dcd

Please sign in to comment.