Updating a BOINC Client Software Installation With The Windows Installer Program
From Unofficial BOINC Wiki
[edit] General
Over time, the BOINC Client Software will be updated with new features to improve the performance, remove Bugs, or to enable new BOINC Powered Projects to be run on the BOINC System. In general, these updates are not expected beyond once or twice a year. As a matter of policy, the BOINC Client Software will not automatically update an installation on the Participant's Computer. This is in contrast with the Science Applications which will be downloaded as needed by the Project. With a low rate of change, and the allowance of older Versions of the BOINC Client Software to be run by the Participant, this should not present significant burden on the Participants.
For example, at the time that this was written, the current "Recommended" Version of the BOINC Client Software for Microsoft Windows® was 4.45, the upcoming Version was 5.2.0 and the oldest allowed Version was 4.19 (allowed by most Projects).
There may also be cases where the "upgrade" is actually done to move to a lower Version Number of the BOINC Client Software. This can occur because of problems with a particular Version on a specific Platform or for some other reason where the newly installed software is not performing as desired.
[edit] Preconditions
In order to complete the procedure outlined in this guide, you must meet the following preconditions:
- You must have an operational computer.
- The BOINC Client Software has an upgrade Version.
- The upgrade Version is required by one of the "Attached" Projects or the new features are desired.
[edit] General Outline of the Upgrade Process
This is the recommended way to update the installed Version of the BOINC Client Software. At least this is how *I* do updates of the software at all Version changes.
It is Ok to have Work Units that are still in progress, the "un-install" process will not touch them. After installing the newer version, the BOINC Daemon will find all your incomplete Work Units, settings, etc. and resume processing essentially right where you stopped.
- Download and install all the latest patches for the Operating System.
- Download the latest Version of the BOINC Client Software.
- Stop the BOINC Manager and the BOINC Daemon (Exit the program see File Menu, or stop the "service").
- Make a copy of the BOINC Directory (folder) from wherever you installed the previous Version. I usually make the copy to a disk other than the one that I installed the BOINC Software or the Operating System. This extra bit of paranoia allows me to do a format install of the Operating System if things go really, really, really wrong.
- Un-install the old Version of the BOINC Client Software using the "un-install" program included with the installed version of the BOINC Client Software or the Windows® "Control Panel".
- Install the new version of the BOINC Client Software.
- Start up the BOINC Client Software and make sure it runs correctly.
- Done!
- Note:
- The normal "un-install" process should *NOT* affect any in-progress work.
If things go bad, I will:
- Un-install the failed Version.
- Restart my computer and make sure the Operating System still starts.
- Delete the existing BOINC Directory.
- Copy the old Version of the BOINC Directory (folder) back.
- Re-install the old Version of the BOINC Client Software (to make sure it has properly registered the installation, etc.).
[edit] Set-Up for the Upgrade Process
[edit] Explanation
You must do some initial steps to set the stage for the upgrade process. These steps include things like down loading the new software, making a back-up, and stopping the BOINC Client Software.
In theory it is possible to upgrade an installation of the BOINC Client Software without stopping the BOINC Daemon and the currently running Science Applications. However, I don't recommend the practice.
[edit] Stop All Other Programs
Stop all programs that you are currently running. Make sure you save your work.
[edit] Enable Your Internet Access
Enable access to the Internet for your computer.
[edit] Download the BOINC Client Software
Now we need to download the BOINC Client Software. Make sure that you select the correct Version to download from this list based on your Operating System.
- Note:
- Download ONLY the Recommended Version! Unless you really know what you are doing with the BOINC Client Software, only use the "Recommended Version!"
I usually download the software to the desktop so it will be easier for me to find. From there, I do the next steps to update the BOINC Client Software.
If you look at the example, you will see that the version we want is the one that is on the first line below the bar indicating Windows. Click on the link "Download". In this example we will get the BOINC Client Software of Version 4.45, which was the latest when this image was taken (unless some sneak changed my example. Curses!).
[edit] Download Page
Right-Click on this link and open it in a new window.
[edit] Download File
Click on the "Download" link in the line "Recommended Version" directly under the "Windows" line.
[edit] Security Warning
Right after clicking the link to download the software, you will most likely get a "Security Warning". Since you need to download this software, click the "Save" button.
[edit] Save As Dialog
Now we need to save the file. The "Save As" Dialog window allows you to save this file to whatever location you wish. I usually download to the "Desktop" as that makes it easy to find. Navigate to the location where you want to save the file and click the "Save" button.
[edit] Download In Progress
Next you will see the download "Progress" dialog window. Mine has the little check mark to close when done. If this window does not close when done. Click the "Ok" button to close it when the download has completed.
[edit] Finishing Up Downloading the BOINC Client Software
At this point you should have an installer Program" icon like this on your Desktop (or in the location you saved the file).
At this point we are ready for the next stage!
[edit] Suspend Work In Progress
- Open the BOINC Manager.
- Select the Projects Tab.
- Select each BOINC Powered Project and click on the "Tasks" Button "Suspend".
- Verify the "Status" column changes to "Suspended by user".
[edit] Stop the BOINC Client Software
Because the BOINC Client Software makes continuous updates to the BOINC Client Directory, many processes we want to do can cause corruption of the "state" files. To prevent this, all we have to do is stop the BOINC Daemon.
[edit] Single-User or Shared Installations
Open the Pop-Up Menu or the BOINC Manager's File Menu and select "Exit" ("Quit" in OS-X). This will shut down the BOINC Manager and the BOINC Daemon.
Goto Verify All BOINC Processes Have Stopped.
[edit] Services Installation
Perform the following:
- Click on the "Start" Button.
- Click on "Control Panel".
- Double-Click on "Administrative Tools" to open the tools folder.
- Double Click on "Services" (Two gears).
In the "Services" window, locate the entry "BOINC" which is the BOINC Daemon. Right-click on the name and select "Properties" from the pop-up menu.
With the "General" tab selected on the "Properties" window, click on the "Stop" button.
A message window with a progress bar will appear and will show the progress of the stop action. It is possible that the BOINC Daemon will not stop. This is usually indicative of more serious problems in Microsoft Windows® than the BOINC Client Software.
[edit] Verify All BOINC Processes Have Stopped
Depress the CTRL-ALT-DEL keys to bring up the "Task Manager".
Click on the column heading "CPU" twice to sort the column from top to bottom use.
When the BOINC Client Software is running you will see activity on one or more processes. In the example shown here this is for a computer with an Intel Pentium 4 processor with Hyper-Threading and so it shows two processes with 50% each.
On a single threaded CPU you will see one process with time varying up to about 99% which should be the currently executing Science Application.
| Project | Known Process Names |
|---|---|
| BOINC | boinc boincmgr |
| Climateprediction.net | hadsm3 hadsm3um sulphur_cycle |
| Einstein@Home | albert einstein |
| LHC@Home | sixtrack |
| Predictor@Home | mfoldB Charmm |
| PrimeGrid | rsa |
| Rosetta@Home | rosetta |
| SETI@Home | setiathome |
| SIMAP@Home | simap |
| SZTAKI Desktop Grid | search |
| World Community Grid | rosetta |
- Note:
- Some of these Application names may be followed by a version number.
- Note:
- Both Rosetta@Home and World Community Grid use an Application named "rosetta", but in almost all cases the version numbers will be different.
If you have been successful in stopping the BOINC Client Software you will see that the "System Idle Process" has most of the available CPU Time.
[edit] Back-Up the BOINC Client Directory
When we do many processes that have potentially dire consequences we should make a archive copy of the BOINC Client Directory so that we can restore our existing system if things go Really wrong.
[edit] Locate Room For the Copy
Check your available disk drives for enough room to save a copy of the BOINC Client Directory. In most cases, our recommendation would be to save the copy on a disk drive other than the disk drive where the BOINC Client Software is installed.
[edit] Drill Down to the BOINC Directory
Double-Click on "My Computer".
Double-Click on "Local Disk (C:)".
- Note:
- We are referencing the "normal" installation location for the BOINC Client Software. If you installed the BOINC Client Software on another disk drive, open that disk drive instead.
Double-Click on "Program Files".
[edit] Select the BOINC Directory
Click on the "BOINC Directory".
[edit] Copy the BOINC Client Directory to the "Clipboard"
With the "BOINC Client Directory" selected, either:
- Press CTRL and "C", or
- Click on the "Edit" menu, then click "Copy".
[edit] Select the Destination
Open the designated destination directory. In this example I selected the current "Program Files" directory.
[edit] Paste the BOINC Directory
"Paste" the copied "BOINC Directory" by either:
- Typing CTRL and "V", or
- Click on the "Edit" menu, then click "Paste".
[edit] Monitor the Paste of the BOINC Directory
Now we get to see the files getting copied into the destination.
[edit] Copy Is Complete
Once the copy process (the "Paste" action) is complete, you should see a new folder. In this case, we did a "Paste" to the same directory as the source so the name is changed to "Copy of BOINC".
[edit] Verify the Copy
Once the copy action has been completed, we want to verify that the content was completely copied. Right-click on the "source" folder and select the "Properties" menu item. Now, right-click on the "source" folder and select the "Properties" menu item.
Compare the folder sizes and the number of files located within those folders. Both the folder size and the number of files must be equal or the save action did not get performed correctly.
[edit] Remove A Prior Installation of the BOINC Client Software
[edit] Explanation
Though it does not happen that often, there are times when the installation of a new Version of the BOINC Client Software will not work correctly unless the prior Version was removed.
[edit] Open The Windows Control Panel
Left-click on the "Start" Button on the Taskbar.
On the "pop-up" menu, select and left-click on the menu item "Control Panel".
[edit] Open "Add or Remove Programs"
Double-click on the icon "Add or Remove Programs" to open the "Add or Remove Programs" Tool.
[edit] Select The "BOINC" Program
Scroll through the list of programs installed and left-click to select the program "BOINC".
[edit] Remove Program "BOINC"
Double check to make sure that the program selected is "BOINC".
Left-click the button "Remove".
[edit] Remove Program "BOINC" Progress
The Microsoft Windows® Control Panel's "Add or Remove Programs" Tool will begin the process of removing the "BOINC" application.
[edit] Verify Program Removal
The program "BOINC" should no longer be shown in the list of programs.
[edit] Close Control Panel
Using the "Close" control at the top right corner, close all opened windows.
Done!
[edit] Performing the Upgrade
[edit] Explanation
At this point we should be ready to perform the actual upgrade process on the BOINC Client Software.
[edit] Running The Windows® "Installer"
Now we can run the "Installer" to perform an installation, update, repair, or removal of the BOINC Client Software on the computer.
[edit] "Installer" Icon
At this point you should have an installer Program" icon like this on your Desktop (or in the location you saved the "Installer" file).
[edit] "Security Warning" Screen
Depending on the version of Microsoft Windows® that you are running you may see this run time warning after you start the "Installer Program".
Click the "Run" button.
[edit] "Splash" Screen
You should see a "Splash" screen like this example as the installer starts the installation process.
[edit] "Welcome" Screen
This is a "Welcome" screen that tells you what program you are going to install.
Click the "Next >" button.
[edit] "License" Screen
Read the license agreement in its entirety, then
Click the radio button icon next to "I accept the terms in the license agreement".
Click the "Next >" button.
- Note:
- If you do not accept the terms, you cannot install the BOINC Client Software.
[edit] "Destination Folder" Screen
This is where you can select a directory into which you will install the BOINC Client Software. If you have a compelling reason to change the directory you can use the "Change..." button to do so.
We strongly advise you to accept the default installation directory.
You may elect to install the BOINC Client Software on a different drive than the default. To change the installation "target", click on the "Change..." button.
Otherwise, and we again recommend to install to the default target, click the "Next >" button and proceed to the "Setup Type" Screen step.
In this window you can navigate to a specific location by:
- "Browsing" to the folder using the drop-down box.
- Also available are the "New Folder" and "Up One Level" icons to the right side, or
- Entering a completely qualified path name in the edit box "Folder name:" (bottom of the window).
When you have selected the correct target location, click "Ok" to use your choice or "Cancel" to abandon the change.
The newly selected target location will now be listed.
If the target is correct, then click the "Next >" button.
[edit] "Setup Type" Screen
There are three types of installation. In the first two types the BOINC Client Software will only run when the computer is on and someone is logged onto the computer. So, choose one of the types based on the criteria discussed above:
- Single-User Installation
The BOINC Daemon runs only when you're logged on, and only you can manage the BOINC Client Software. That is to say, the BOINC Client Software only runs when this account has been used to log-on to the computer. - Shared Installation
The BOINC Daemon runs when anyone is logged on to any of the accounts for this computer. - Service Installation
The BOINC Daemon runs at all times when the computer is operational.
- Note:
- If you are unsure which installation type is right for you, you can review the material above to aid you in your choice. Alternatively, you can install with the "Single-User Installation" at this time and then, later on, change the installation type with an update install using the BOINC "How-To" Guide: "Updating a BOINC Client Software Installation With The Windows Installer Program".
[edit] "Installation Configuration" Screen
This screen allows you to set two of the options on how you want the BOINC Client Software to operate on your computer. The choices are pretty self-explanatory. If you do not want one of the choices to go into effect, click on the check mark to clear it.
This example shows the settings for the "Single-User Installation", the "Shared Installation" looks the same with the exception of the title.
If you have chosen to use the "Service Installation" see the this additional step.
When you are done, click the "Next >" button.
[edit] "Ready to Install the Program" Screen
The moment of truth. If you are not sure about your settings, use the "< Back" to go back and review your settings.
If you are sure you have the correct settings, then ...
Click the "Install" button.
[edit] "In Progress" Screen
After you have started the install, you will see a screen like this example.
[edit] "Finish" Screen
We suggest that you leave the check mark "set" (the default).
Click the "Finish" button.
[edit] Initial Launch of the Updated BOINC Client Software
[edit] Explanation
As in the initial installation of the BOINC Client Software, the first thing that is done is the Benchmark Test is executed. A "typical" Benchmark Test will look something like:
To pause/resume tasks hit CTRL-C, to exit hit CTRL-BREAK 2005-10-03 01:25:44 [ ] Starting BOINC client version 5.1.6 for windows_intelx86 2005-10-03 01:25:44 [ ] libcurl/7.14.0 OpenSSL/0.9.8 zlib/1.2.3 2005-10-03 01:25:44 [ ] Data directory: C:\Program Files\BOINC 2005-10-03 01:25:44 [SETI@home ] Found app_info.xml; using anonymous platform 2005-10-03 01:25:44 [ ] Processor: 4 GenuineIntel Intel(R) Xeon(TM) CPU 3.40GHz 2005-10-03 01:25:44 [ ] Memory: 1022.08 MB physical, 2.40 GB virtual 2005-10-03 01:25:44 [ ] Disk: 68.87 GB total, 55.35 GB free 2005-10-03 01:25:44 [ ] Version change detected (4.45.0 -> 5.1.6); running CPU benchmarks 2005-10-03 01:25:44 [rosetta@home ] Computer ID: 2218; location: home; project prefs: default 2005-10-03 01:25:44 [climateprediction.net] Computer ID: 150264; location: home; project prefs: default 2005-10-03 01:25:44 [Einstein@Home ] Computer ID: 102567; location: home; project prefs: default 2005-10-03 01:25:44 [LHC@home ] Computer ID: 30898; location: home; project prefs: default 2005-10-03 01:25:44 [Predictor @ Home ] Computer ID: 89715; location: home; project prefs: default 2005-10-03 01:25:44 [SETI@home ] Computer ID: 715569; location: home; project prefs: default 2005-10-03 01:25:44 [ ] General prefs: from SETI@home (last modified 2005-10-01 23:26:37) 2005-10-03 01:25:44 [ ] General prefs: no separate prefs for home; using your defaults 2005-10-03 01:25:45 [ ] Remote control allowed 2005-10-03 01:25:47 [ ] Running CPU benchmarks 2005-10-03 01:26:16 [ ] request_reschedule_cpus: project op 2005-10-03 01:26:46 [ ] Benchmark results: 2005-10-03 01:26:46 [ ] Number of CPUs: 4 2005-10-03 01:26:46 [ ] 1506 double precision MIPS (Whetstone) per CPU 2005-10-03 01:26:46 [ ] 1334 integer MIPS (Dhrystone) per CPU 2005-10-03 01:26:46 [ ] Finished CPU benchmarks
The really "keys" we need to look at are the messages that read:
Starting BOINC client version 5.1.6 for windows_intelx86 Version change detected (4.45.0 -> 5.1.6); running CPU benchmarks
These is our first indication that the update process worked correctly. We can see that the newer Version Number is correctly registered.
[edit] Testing The Upgrade
After the Benchmark Tests have completed, you can re-enable the "suspended" BOINC Powered Projects one by one. My recommendation, for paranoia's sake, is to enable only one Project at a time until you are confident that the upgrade performed correctly.
[edit] Finishing The Upgrade
[edit] Explanation
In this stage we do those activities to finish the installation and clean-up your computer.
[edit] Delete/Save Installer Program
If you only have one computer that you are going to use with the BOINC Client Software, and you do not want to save the Installer Program; select the icon on the desktop (or wherever you downloaded it to) and drag it to the "Trash".
If, however, you want to be able to install the BOINC Client Software on another computer, or, you want to preserve the Installer Program move it to a shared folder for local access or to a "save" directory.
You really should save the "installer" program for those cases where you need to un-install, or repair an installation of the BOINC Client Software.
[edit] What To Do When The Upgrade Goes Bad
[edit] BOINC "How-To" Guides Related To Installation
The list that follows contains the BOINC "How-To" Guides, in rough order of use, that are used in the installation and set-up of the BOINC Client Software.
- Note:
- Don't panic! I have pictures and everything!
- Installing the BOINC Client Software And Participating In A BOINC Powered Project (Master Guide)
- Choosing a BOINC Powered Project
- Joining a BOINC Powered Project
- Installing:
- Installing The BOINC Client Software on Microsoft Windows® (all versions).
- Installing The BOINC Client Software on Apple Macintosh OS-X (only; do not attempt to install or run the BOINC Client Software on OS-9)
- Installing The BOINC Client Software on Linux (x86 versions only)
- Installing The BOINC Client Software on SPARC/Solaris
- BOINC and SETI@Home Quick Install Guide for HPUX
- Attaching The BOINC Client Software To A BOINC Powered Project
- Updating or Repairing the BOINC Client Software:
- Updating a BOINC Client Software Installation With The Windows Installer Program
- Repairing a BOINC Client Software Installation With The Windows Installer Program
- Detaching The BOINC Client Software From A BOINC Powered Project
- Uninstalling the BOINC Client Software:
- Miscellaneous Installation Related Tasks
- Deprecated Procedures
[edit] Other Related Messages
- Aborting CPU benchmarks, one or more active tasks are still running (Obsolete)
- Benchmark results:
- CPU benchmarks timed out, using default values
- Failed to stop applications; aborting CPU benchmarks
- Finished CPU benchmarks
- Number of CPUs: '(Nbr of CPUs)'
- Number of usable CPUs has changed. Running benchmarks.
- Pausing result '(result)' (removed from memory)
- Resuming computation and network activity
- Running CPU benchmarks
- Suspending computation and network activity - running CPU benchmarks
- Version Change Detected (x.y -> x1.y1); running CPU benchmarks
- XXXX double precision MIPS (Whetstone) per CPU
- YYYY integer MIPS (Dhrystone) per CPU
