Installing the BOINC Client Software And Participating In A BOINC Powered Project: Version 4
From Unofficial BOINC Wiki
[edit] General
General Installation Notes
It is very easy to get started on participating and helping researchers with your donated computer time. On this page we will give you a step by step procedure which will guide you through the process of getting you up-and-running the BOINC Client Software.
The steps are as clear, logical, and detailed as I can make them. Even if you have never installed a program before it is my hope that you will have all of the steps and illustrations that will facilitate this experience.
For those that do not need as much detail, I have tried to make the presentation as streamlined as possible for you also.
My suggestion is that you read through the instructions from end to end before you start.
One last note, some of the Projects may not be open for new Accounts. Other Projects are not producing a lot of work at this time. All of these things will change as the BOINC Powered Projects get going and mature. We recommend that you sign up for at least two projects so that you will always have work to process.
Ready?
Ok, here goes …
Installation Preconditions
In order to complete the procedure outlined in this guide, you must meet the following preconditions:
- You must have an operational computer.
- You must administation rights on the computer.
- You must have Internet Access from this computer.
- You must be able to operate the computer and access the Internet.
[edit] Step-by-Step Instructions
Installation Step: Overview
You can get a very brief introduction to the BOINC System and how it works by reading "Getting Started". The Wiki is extensive and we do what we can to make this as easy as possible. By way of example, you will notice that we have many terms tied to links, so, you can look up an explanation of any defined term or phrase.
Installing the BOINC Client Software
We will start the process by having you install the BOINC Client Software. Select the correct installation instructions from this list:
- 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
- Note:
- Additional installation and start-up instructions and scripts are listed on the UCB site as:
Installation Notes For SETI@Home Classic Participants
If you had an account in the original 'SETI@Home Classic' project as of 14 May 2004. We've transferred your Account, including Profile and Team information. Use the same e-mail address which was used to establish and maintain your SETI@Home Classic account in this form to obtain your Account Key. If you created a SETI@Home Classic account after 14 May 2004 all is not lost. If you create a SETI@Home BOINC account using the same email address as the SETI@Home Classic account they may be combined automatically at some point.
- Note:
- The new form allows you to link to your account in one of several different ways. Provided you have the required information you will be able to link the two project accounts together. Allowing you to show your contribution as shown in this example.
- Note:
- Apparently, the password for a classic account can be found in the result_head.sah file stored as the user ID.
Once you have created your Account, skip ahead.
[edit] Choosing a BOINC Powered Project
We have a guide on Choosing a BOINC Powered Project", read that first and decide which Project or which Projects you wish to support.
[edit] Create An Account
[edit] Reading the "Rules and Policies" for the BOINC Powered Project
You need to know what you are getting into, so, read the Rules and Policies for the Project.
From the list below, select a Project and click on the link in the second column to get the "official" Rules and Policies for the Project for which you wish to be a Participant. If you need help with the page, there is documentation available for the page, click on the "Page Doc." icon in the first column.
| Project | URL | Documentation |
|---|---|---|
| Climateprediction.net (CPDN) | Rules and Policies | "Rules and Policies" Page |
| Einstein@Home | Rules and Policies | |
| LHC@Home | Rules and Policies | |
| Predictor@Home | Rules and Policies | |
| Rosetta@Home | Rules and Policies | |
| SETI@Home | Rules and Policies | |
| SIMAP@Home | Rules and Policies | |
| SZTAKI Desktop Grid | Rules and Policies | |
| World Community Grid | See the link "Software License Agreement" on this page. |
[edit] Creating an Account
Next you need to open up an Account for a BOINC Powered Project by by filling in a form supplying a a valid e-Mail address that can be used to send to you your Account Key for that particular BOINC Powered Project.
[edit] Wait for the e-Mail from the Project
While we are waiting we should tell you that we have lots of things that can help you along the way.
On the main page of the Project Web Site is as complete section devoted to helping you in every way possible. You should also note that we have lots of links that you can follow into some of the resources. Feel free to wander about.
If we still have more time to kill, how about a quick introduction to the goals and operation of the BOINC Client Software with "Getting Started" ... and this is the last time I am going to offer this!
[edit] Print and Save the e-Mail
Ok, now you have your Account Key? Cool! Print out the e-Mail that contains that Account Key and put it in a safe place. You do want to protect that Account Key, but we are going to use it right now. Select the Account Key in the e-Mail and then copy it to the clipboard (also see "Detailed Instructions on Selecting the Account Key").
- Note:
- The reason we stress saving the copy of the Account Key is that if it is lost, most BOINC Powered Projects are not able to help you recover the Account if you lose the Account Key and no longer have access to the e-Mail account used to join the BOINC Powered Project. I save all of mine in a separate text file.
[edit] Configure Your Account
Now, we will open the appropriate form and paste the Account Key into the field; then click "Ok" to submit the "Configure Your Account" Form. This process used be known as Account Activation. Select the correct BOINC Powered Project form:
[edit] Attaching to a BOINC Powered Project
Now that you have the BOINC Client Software installed on your computer and the initial Benchmarks have been run, you are ready to put your computer to work. To do this we have to "Attach" the BOINC Client Software to a BOINC Powered Project.
Detailed steps are available in the BOINC "How-To" Guide:
[edit] Attaching to Another BOINC Powered Project
You can now, add additional BOINC Powered Projects to your computer by completing the steps above starting at "Choosing a BOINC Powered Project".
When doing this be sure to carefully consider your work allocation, which we call Resource Share and the total number of BOINC Powered Projects you want to support. There are also considerations you should make on how large you make your Work Buffer. In general, when you are a Participant in multiple BOINC Powered Projects this setting can be very low, typically a recommended value is to be less than one day.
For those of us that do want to "hoard" more work the maximum should not be more than the shortest Result Deadline divided by the number of Projects attached to that computer.
We strongly suggest you review the topics:
- Resource Share
- Work Buffer
- Configuring Your Computer, Your Accounts, and Preference Settings When Running BOINC Powered Projects
- "General Preferences" Page
- "Edit General Preferences" Form
[edit] Pat Yourself On The Back
Pat yourself on the back, you should be up and running.
If you think that you have a problem with the installation, the first place to go is to the Questions and Problems Page where you can post a message in one of the Forums in that Forum with a description of your suspected problems. There are a lot of people there who will be more than happy to assist you in the resolution of the problem
Ok, now that you have the BOINC Client Software installed and you are up and running, we want you to know that there are some resources that you can access to configure your BOINC Client Software to run. This gives you the opportunity to have BOINC Client Software "just right" for you.
The way that this is done is to use your preference settings and the way that those can be used are documented in the "Quickie Guide" and the BOINC Web Site Owner's Manual.
Happy "Crunching"!
[edit] Configuring Multiple Computers Under One Account
[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:
- Detaching The BOINC Client Software From A BOINC Powered Project
- Uninstalling the BOINC Client Software:
- Miscellaneous Installation Related Tasks
- Deprecated Procedures
- Installing the BOINC Client Software And Participating In A BOINC Powered Project: Version 4
- Creating an Account For A BOINC Powered Project - BOINC Client Software Version 4.x
