Linux Install Guide

Software Version 7.3.x+ (V7)

 

Introduction to V7

The new Folding@home (FAH) software is configured, controlled, and monitored through a new simpler graphical interface named Web Control. This new web browser based application has incorporated many new features, including client monitoring and configuration of all FAH clients. Web Control is now the recommended interface for all FAH types (Single core CPU, Multi-core CPU, GPU), replacing both the Systray and the Console versions of FAH.  The more advanced FAHControl application is also available.

What is new in V7?

We are pleased to say that everything is new in this version, using completely new software coding from the ground up. Our goal is to include the best features from the previous clients, make improvements where possible, discard what was no longer needed, then add new features like the Express mode package installer, the new FAHViewer, and the new unified interface. V7 has all of these and more, making installation and configuration much simpler and faster for new users, while continuing to support advanced options.

Note: There are too many updated and new features to list in an Installation Guide, so this section only covers What’s New when installing V7 software. Please read the V7 Introduction page for basic information and explanations of the new client features.

New Terminology

The V7 software really changes the concept of how people interact with FAH. And with new concepts come new or updated terms to describe those concepts. Learning new references is part of the process for change and improvement.

  • Web Control – This is the new simpler graphical interface (front-end). Web Control will configure and monitor one or more FAHClient slots through an easy to use web page.  This is the default control program.
  • FAHControl – This is an alternate new graphical interface (advanced front-end). FAHControl will configure and monitor one or more FAHClient (slots), on one or more computers. This more advanced interface is optional.
  • FAHClient – This is the (back-end) client software managed by FAHControl and typically runs behind the scene. This is a truly unified client (slot) manager. FAHClient starts one or multiple instances of a Fahcore and manages the work assignments for each of these client “slots.”
  • FAHSlot – aka “slot” – Each Fahcore and the data associated with it is called a slot. For example, one FAHSlot can be associated with a GPU and another slot associated with the CPU. Each folding slot can download, process, and upload results independently. The FAHClient manages each slot, and FAHControl monitors and displays their progress independently.
  • FAHViewer – This is the new and fully functional work unit viewer. FAHViewer is modeled after the very popular PS3 viewer, and continues to offer the many rendering options, ball and stick, space fill, zoom, rotation, etc., and adds snapshot capture and cycling to show folding in action.
See also the FAHControlFAHClient , and FAHViewer documents for more information about setup and customization options.

 

Requirements

The new V7 software has the same basic hardware and operating system requirements as the previous clients. However, a few software specific requirements have changed to support newer features. Listed by slot type:

  • CPU Slot Requirements
    • Recent 32 bit or 64 bit Linux distribution, Ubuntu 11.04, Red Hat 6.x, OpenSUSE 11.x
    • Intel P4 1.4 GHz processor or newer, or AMD equivalent (modern multi-core processors recommended)
      • A limited selection of Projects are available for 32-bit
      • A limited selection of Projects are available for single core processors, as the End Of Life for single core projects was announced in August 2013
      • Projects for higher numbers of cores may require 64-bit and have shorter deadlines, generally requiring a client running at or close to 24/7
    • Broadband internet connection or faster

Note: There are many linux distributions and flavors, each with its own list of software dependencies. The V7 client attempts to meet the most common list of dependencies in the latest linux versions. However, addition effort to meet a specific software dependency may be required for V7 to run.

  • GPU Slot Requirements
    • Recent 32 bit or 64 bit Linux distribution, Ubuntu 11.04, Red Hat 6.x, OpenSUSE 11.x
    • Supported GPU, see below
    • FAHClient running more than part time to meet shorter deadlines
    • Broadband internet connection or faster
    • 1 or more supported GPU video cards
      • ATI/AMD (In beta testing, see Notes below)
        • (GPU3 – OpenCL – FAHCore_17)
          • OpenCL compatible GPU, 5xxx series or newer, see full list
          • 14.4 AMD device driver or newer
      • NVIDIA
        • (GPU3 – OpenCL – fahcore_17)
          • OpenCL compatible GPU, 4xx series and above (Fermi and Kepler) or newer*
          • 301.xx NV device driver or newer (327.xx is a known stable version)

Note: GPU drivers, models, features, and support develop very quickly. Please note these specific issues.

  • Automatic updating of the GPUs.txt is now supported in V7.3.x and newer.
  • See the Folding Support Forum New GPUs (whitelist/blacklist) section for more information about the GPU hardware (supported HW list, aka greylist) with newer GPUs.
  • FAHCore_11, FAHCore_15, and FAHCore_16 are not supported in linux, and are going End Of Life.  FAHCore _11 EOL was announced in March 2011, and scheduled to end in September 2011.
  • Folding on NV GPUs is currently limited to 64 bit distros, with a 32 bit option coming soon.
  • Non-GK110 GPUs may experience half speed folding when using NVidia drivers newer than 327.xx.  GK110 based GPUs experience no slow down in newer drivers.  Waiting on a driver fix from NV.  There is a potential for a fahcore workaround, in testing now.
  • *New GPU models with newer chip architecture may not be supported by the current software.  New fahcores and/or new drivers with updated optimizations may be required for full support.  New fahcores will not be available until some time after the new hardware products are sold to the public.  Then the fahcores and drivers may be updated, tested, and verified before released for folding.
  • Folding on AMD GPUs is problematic in linux due to poor OpenCL driver suppport from AMD. Linux GPU folding is still in beta testing.

Quick Start

This section describes how to get started folding quickly with the new V7 software and the default FAHClient slot(s).

  • Download the package for your distro.
  • Click Install Package.
  • Enter password and click OK.
  • Click Forward, click close.
  • Done.

After the download, the new V7 software is installed as a service and folding in under 1 minute. Very quick and easy. For a more guided installation, please see the Express Install or Custom Setup sections.

Express Installation – Recommended!

This section describes the recommended method for installing the V7 FAH software for an individual client slot using a software package in Linux. A first time installation is assumed. And unless otherwised noted, the default setting for each option is the recommended setting.

Select the appropriate V7 package for your Linux distribution from the V7 download page. (see figure 1). There are separate installation packages for the new FAHControl (client manager) interface software, the new FAHClient (slot manager) software, and the new FAHViewer (viewer) software. FAHClient is required, FAHControl is recommended, FAHViewer is optional.

V7 DownloadsV7 Downloads
Debian / Ubuntu <– Figure 1 –> Fedora / Red Hat

Click the link for a matching operating system to start the software installation.

Linux will ask how to handle the package file download (see figure 2).

Downloading PackageDownloading Package
Debian / Ubuntu <– Figure 2 –> Fedora / Red Hat

When prompted, click OK to open the package installer.

Note: Some versions of Linux do not have a package installer program listed to open the file directly. The only option is to save the file, and then open the file with the software manager. The process is very similar and the rest of the setup is the same.

The Package Installer is displayed (see figure 3).

Package InstallerPackage Installer
Debian / Ubuntu <– Figure 3 –> Fedora / Red Hat

Click the Install Package or Apply button to continue the installation.

Enter an administrator password when prompted (see figure 4).

Enter PasswordEnter Password
Debian / Ubuntu <– Figure 4 –> Fedora / Red Hat

Click OK to continue.

The Package Installer prompts for initial setup information in Debian / Ubuntu installs only (see figure 5).

Note: Fedora / Red Hat .rpm packages do not support prompting for setup information. Instead, the client is set to paused so initial setup information may be entered through the FAHControl interface.  However, there is a 5 minute time limit on this initial pause.  After that, the client will start and download work using the current default settings.

Initial Setup
Figure 5

Additional configuration changes are optional and may be skipped. The client will run as user: Anonymous on team: 0 by default. Or a Donor Name, Team number, and/or Passkey number may be configured. Entering a passkey is recommended but not required. However, a passkey is required to participate in the Quick Return Bonus points system.

Note: Express Installation (ALL) automatically installs a single client slot to match the computer hardware detected. If multiple CPU cores are detected, a multi-core CPU slot is installed. If not, then a single core CPU slot is installed as the fall back option. A GPU slot option is now supported in the Linux client via beta testing.

Click Forward to continue.

The Package Installer shows installation progress (see figure 6).

Installing PackageInstalling Package
Debian / Ubuntu <– Figure 6 –> Fedora / Red Hat

Finishing the install will take another minute or two.

Installation is complete (see figure 7).

Package InstalledPackage Installed
Debian / Ubuntu <– Figure 7 –> Fedora / Red Hat

Click the Close button. The V7 software is installed and running as a service.

Repeat steps 1 – 7 with the FAHControl package, and optionally, the FAHViewer package.

Settings may be updated and progress can be monitored in FAHControl (see figure 8).

Starting FAHControlStarting FAHControl
Debian / Ubuntu <– Figure 8 –> Fedora / Red Hat

The FAHControl application launches.

This is the FAHControl (client manager) interface . The client should display ONLINE and Running (see figure 9).

FAHControl
Figure 9

V7 software is now installed and folding.

Please read the V7 Introduction page for basic information and further explanations of the new client features.

See also the FAHControl (client manager), FAHClient (slot), and FAHViewer (viewer) documents for more information about setup and customization options.

While the default options are typically the recommended options, see the Configuration FAQ for additional setup options.

Manual Installation – Optional (Advanced)

Here are the basic command-line instructions to install and run the V7 Folding@home software.

Open the Terminal / Console application. Depending on the Linux distribution (Ubuntu, Fedora, etc.), OS version, and desktop engine (KDE, GNOME, Unity, etc.) the Terminal / Console application may be found in a variety of locations. It is typically located under Accessories, or System Tools.

Type each command exactly as it appears, or cut and paste directly from this guide.

Note: The installation commands shown include options to continue even when exact dependencies are not met. The V7 software is rather generic and works with most, if not all, version of the various libraries.

Terminal installation for Debian / Mint / Ubuntu

Download the installation package files; 64-bit versions shown. If using an i386/i686 32-bit OS version, download those files as appropriate from the client download page.

 wget --no-check-certificate https://fah.stanford.edu/.../fahclient_7.4.4_amd64.deb
 wget --no-check-certificate https://fah.stanford.edu/.../fahcontrol_7.4.4-1_all.deb
 wget --no-check-certificate https://fah.stanford.edu/.../fahviewer_7.4.4_amd64.deb

Install the FAHClient.

 sudo dpkg -i --force-depends fahclient_7.4.4_amd64.deb

The package will prompt for initial setup information, user name, etc. Enter information or change as needed, and click OK.

Install the FAHControl application.  Root privileges are required.

 sudo dpkg -i --force-depends fahcontrol_7.4.4-1_all.deb

Optionally, install the FAHViewer.

 sudo dpkg -i --force-depends fahviewer_7.4.4_amd64.deb

Done. The FAHClient is installed and running as a service. Manage, monitor and update settings using the FAHControl.

Terminal installation for RedHat / CentOS / Fedora

Download the installation package files; 64-bit versions shown. If using an i386/i686 32-bit OS version, download those files as appropriate from the client Download page.

 wget --no-check-certificate https://fah.stanford.edu/.../fahclient-7.4.4-1.x86_64.rpm
 wget --no-check-certificate https://fah.stanford.edu/.../fahcontrol-7.4.4-1.noarch.rpm
 wget --no-check-certificate https://fah.stanford.edu/.../fahviewer-7.4.4-1.x86_64.rpm

Install the FAHClient.

 rpm -i --nodeps fahclient-7.4.4-1.x86_64.rpm

Note: Fedora / Red Hat .rpm packages do not support prompting for setup information. Instead, the client is set to pause on start so initial setup information may be entered through the FAHControl interface.

Install the FAHControl application.  Root privileges are required.

 su -c 'rpm -i --nodeps fahcontrol-7.4.4-1.noarch.rpm'

Optionally, install the FAHViewer.

 su -c 'rpm -i --nodeps fahviewer-7.4.4-1.x86_64.rpm'

Done. The FAHClient is installed and is ready to run as a service. Open FAHControl, enter user information, then unpause the client. Manage, monitor and update settings as needed.

Note: If the FAHControl application still has dependency issues with the installed version of Python, there is a work around to copy the FAH Python files to the newer Python folder.  These commands assume that FAH is set to use Python 2.6, and Linux has Python 2.7 installed.

Create a link from the newer version to the older version.

 cd /usr/lib
 sudo ln -s /usr/lib/python2.7 /usr/lib/python2.6

Copy the fah module from the old location to the new location.

 sudo cp -R /usr/lib/python2.6/site-packages/fah /usr/lib/python2.7/site-packages/fah

This resolves the FAHControl dependency and will allow the application to run in the newest distributions of linux.

Note that using this virtual link to Python may cause Yum to complain the next time a Python update is available.  Removing FAHControl from the RPM database will resolve this problem.

 sudo rpm -e --justdb FAHControl

File Locations

The cores, logs, and work folder, plus current log file, are located here:

 /var/lib/fahclient

The config.xml file is located here:

 /etc/fahclient

The FAHClient is started and stopped via the service script in /etc/init.d/FAHClient.

 sudo /etc/init.d/FAHClient start
 sudo /etc/init.d/FAHClient stop

Both stop and start may be combined via this command:

 sudo /etc/init.d/FAHClient restart

Command Line Only Options

There are two options for running the FAHClient in Linux:

  1. Run as a system service. This is the recommended and default option. The FAHClient service is installed automatically via the installer package, and will start at boot. Then control and configure the FAHClient with FAHControl. Note that FAHControl will not start or stop the FAHClient process. This setup uses /etc/fahclient/config.xml and runs in /var/lib/fahclient/. Do not run FAHClient directly when the service is running.
  2. Run from command line. Alternately, with the service disabled, it is possible to run the FAHClient manually from the command line in a directory of your choice. FAHClient will run in the current directory and use a config.xml from the same directory.

Both of these options can be headless if choosing not to use FAHControl. The FAHClient can be configured for remote access by editing /etc/fahclient/config.xml, but please be very careful in doing so. The FAHClient is started and stopped via the service script in /etc/init.d/FAHClient.

 sudo /etc/init.d/FAHClient start
 sudo /etc/init.d/FAHClient stop

Services are started and stopped by root but the client will automatically drop root privileges when run this way. It runs in the restricted fahclient account for added security. Starting and stopping the service is however, not at all necessary if when using FAHControl. Instead pause/unpause the FAHClient. When paused the FAHClient should idle in the background using negligible resources.

The plain command line only FAHClient tarball is available for download here.

Note: There is no install guide or support in the forum for this type of expert only installation. The only support for command-line only installs is this:

Documentation:

 ./FAHClient --help

Configuration using config.xml:

 ./FAHClient --configure

Configuration with no config file (minimum flags):

 ./FAHClient --user=Anonymous --team=0 --passkey=1385yourpasskeyhere5924 --gpu=false --smp=true

Table of Options

The Configuration Guide provides information on some of the more common V7 options. Some options are operating system specific.

How to Uninstall V7

This section describes how to uninstall V7 FAH application.

Please let the current Work Unit finish and upload (using “Finish”). Exit the FAHControl application.

Open a terminal window. Enter the command appropriate for your version of Linux:

Ubuntu:

 sudo dpkg -P fahclient

Fedora:

 su -c 'yum remove fahclient'

Press Enter.

Enter password when prompted.

Press Enter.

Repeat for the fahcontrol and fahviewer packages if also installed.

Uninstall is complete.

 

Install Guide Updates

I found a better way to install the V7 client, where can I make a suggestion?

The install guides are written and updated by the folding community, and managed by the Pande Group. Please post any suggestions, corrections, or update recommendations in the Folding Forum. And thank you for helping to improve the install guides.

For More Information, Please See:

Last Updated on July 23, 2014, at  4:20 PM

 

Add your computer's power to over 327,000 others that are helping us find cures to Alzheimer's, Huntington's, Parkinson's and many cancers ...

... in just 5 minutes.

Step 1.

Download protein folding simulation software called

Folding@home

.

Step 2.

Run the installation. The software will automatically start up and open a web browser with your control panel.

Step 3.

Follow the instructions to Start Folding.

Stanford University

will send your computer a folding problem to solve. When your first job is completed, your computer will swap the results for a new job.

Download the protein folding simulation software that fits your machine.

()


Installation guide