Skip to content

Commit

Permalink
doc(README): update installation documation
Browse files Browse the repository at this point in the history
BREAKING CHANGE: change the version to 1.0
  • Loading branch information
MingboPeng committed May 8, 2022
1 parent f4c18ae commit ef1e841
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 12 deletions.
6 changes: 2 additions & 4 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,11 @@ jobs:
run: |
echo "ReleaseVersion=${{ steps.semantic.outputs.new_release_version }}" >> $GITHUB_ENV
- name: Update versions
run: |
echo ${{ env.ReleaseVersion }}
- name: MSBuild GH Plugin
run: |
msbuild src/Ironbug.Grasshopper/Ironbug.Grasshopper.csproj /p:Configuration=Release /p:Platform=x64 /p:Version=1.2.0 /restore
echo ${{ env.ReleaseVersion }}
msbuild src/Ironbug.Grasshopper/Ironbug.Grasshopper.csproj /p:Configuration=Release /p:Platform=x64 /p:Version=${{ env.ReleaseVersion }} /restore
mkdir installer/plugin
mv src/Ironbug.Grasshopper/bin/x64/Release/Ironbug.* installer/plugin
Expand Down
36 changes: 28 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,17 +31,37 @@ Sort and group the Rhino geometries based on its layer information. It is very u

A set of 80 components (by Aug 4, 2018) for creating highly customizable HVAC systems including: Air handling unit, Water loops (hot water, chilled water, condensing water), and VRF.

## Installation
1. Download the [Ironbug.zip (1.4 MB)](https://github.com/MingboPeng/Ironbug/releases) and unblock the file.

![Image of Ironbug](https://github.com/MingboPeng/Ironbug/blob/master/doc/GIF/unblock.gif)

2. Unzip to `C:\Ironbug`, and open 00_installer.gh in Grasshopper.
![image of folder](https://discourse.ladybug.tools/uploads/default/original/2X/5/5fe511542effa4a87dd90c7a2a435bfc6474eba9.png)
# Installation

3. Find the OpenStudio folder path on your computer, and set toggle to true to install.
![image of installer](https://github.com/MingboPeng/Ironbug/blob/master/doc/GIF/installer.gif)
**Prerequisite**: Ironbug v1.0 and above only works with the new Ladybug Tools (not the legacy version). It is suggested to use the [Pollination installer](https://www.pollination.cloud/grasshopper-plugin) to install the Ladybug Tools, which comes with all compatible libraries and engines.

1. Download the Ironbug [single-click installer](https://github.com/MingboPeng/Ironbug/releases) and execute it with admin privilege.

2. The installer will auto-select the valid Ladybug Tools' installation folder, and install the Ironbug to its `grasshopper\ironbug` folder.
![image](https://user-images.githubusercontent.com/9031066/167290376-b49e9995-48c8-4829-8bfd-df3412744470.png)

3. Finish the installation and enjoy!

Note: installing the Ironbug with the new single-click installer will automatically remove the old Ironbug (if any) from `C:\Ironbug`.

## Installation Issues:

### 1. Ironbug can't find the OpenStudio:
Ironbug only uses the OpenStudio that is installed to the Ladybug Tools installation folder. If you use the Pollination installer to install Ladybug Tools, the OpenStudio is installed to `C:\Program Files\ladybug_tools\openstudio`. The easiest way to fix this issue is to use the [Pollination installer](https://www.pollination.cloud/grasshopper-plugin) to install the LBT plugins.

### 2. Single-click installer can't find the Ladybug Tools' installation folder
It is likely you installed the LBT from Food4Rhino, or installed to LBT to a non-standard location that Ironbug's installer can't find it. The following two directories are checked by the installer to find the Ladybug Tools' installation folder:

1. C:\Program Files\ladybug_tools\
2. C:\Users\USERNAME\ladybug_tools\

The easiest way to fix this issue is to use the [Pollination installer](https://www.pollination.cloud/grasshopper-plugin) to install the LBT plugins.

If you really have to install the Ladybug Tools to a customized directory, for example `D:\ladybug_tools`, you will have to manually point the Ironbug's installer the correct Ladybug Tools folder. In this case, the installation path will be `D:\ladybug_tools\grasshopper\ironbug`

### More issues?
Post an issue here: https://github.com/MingboPeng/Ironbug/issues/new

4. Restart the Grasshopper, and enjoy!

Binary file removed doc/GIF/InstallIronbug.gif
Binary file not shown.
Binary file removed doc/GIF/installer.gif
Binary file not shown.
Binary file removed doc/GIF/unblock.gif
Binary file not shown.

0 comments on commit ef1e841

Please sign in to comment.