Difference between revisions of "Folding@home"

From ArchWiki
Jump to: navigation, search
(The graphical way)
m (Format)
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
[[Category:Mathematics and science]]
 
[[Category:Mathematics and science]]
From the [https://aur.archlinux.org/packages.php?do_Details=1&ID=11852&O=0&L=&C=&K=folding&SB=&SO=&PP=&do_MyPackages=&do_Orphans=&SeB= AUR package page]: "''Folding@home is a distributed computing project which studies protein folding, misfolding, aggregation, and related diseases.''"
+
From the project [http://folding.stanford.edu/ home page]:
 +
: ''Help Stanford University scientists studying Alzheimer's, Huntington's, Parkinson's, and many cancers by simply running a piece of software on your computer. The problems we are trying to solve require so many calculations, we ask people to donate their unused computer power to crunch some of the numbers. In just 5 minutes... Add your computer to over 333,684 others around the world to form the world's largest distributed supercomputer.''
  
Please see the [http://folding.stanford.edu/ Folding@home site] for a fuller description.
 
 
== Installation ==
 
== Installation ==
  
Just install "foldingathome" from the AUR.
+
Install {{AUR|foldingathome}} from the [[AUR]].
 
+
$ yaourt -S foldingathome
+
  
 
== Configuration ==
 
== Configuration ==
  
===The graphical way===
+
Run {{ic|/opt/fah/FAHClient --configure}} as root to generate a configuration file at {{ic|/opt/fah/config.xml}}. (the Arch Linux team number is 45032) Alternately, you can write {{ic|opt/fah/config.xml}} by hand and use {{ic|/opt/fah/sample-config.xml}} as a reference. With a config file in place, you can start the daemon, check it's status, and make the daemon automatically start at boot time:
  
Simply run {{ic|./FAHClient --configure}} in {{ic|/opt/fah/}} to configure your client for the first time. Afterwards you can use a webbrowser or FAHControl on the same machine to set slots.
+
# systemctl start foldingathome
If you want to control it from a remote host, you have to remove the proxy line {{ic|<proxy v=':8080'/>.</nowiki>}} and perhaps add an "allow" entry and password entry.
+
  $ systemctl status foldingathome
  <allow v='<ip of the host supposed to be controling the machine>'/>
+
  # systemctl enable foldingathome
  <password v='password'/>
+
  
You can also allow a remote host to connect to the python web server.
+
=== The graphical way ===
Just add a line like this:
+
<web-allow v='ip of the remote host'/>
+
  
===The terminal way===
+
You can manage the daemon by opening a web browser and heading to http://localhost:7396/. Alternately, you can install {{AUR|fahcontrol}} and use the FAHControl program.
In order to edit the configuration, edit the file "client.xml" in {{ic|/opt/fah}} with the editor of your choice.
+
For example nano:
+
  
# nano /opt/fah/client.xml  
+
The daemon can also be controlled remotely. Instructions for doing so are listed in {{ic|/opt/fah/sample-config.xml}}. Remember to open firewall ports if necessary.
  
The most important settings here are:
+
=== The terminal way ===
  
*username, username associated to the work-units you return (not related to the User variable in {{ic|/etc/systemd/system/foldingathome.service}}).
+
To see the current progress of foldingathome, simply {{ic|$ tail /opt/fah/log.txt}}.
<user v='your username'/>
+
 
*team, the team number you wish to contribute points to (earned for work units returned), you will of course want to fill in 45032, the arch-linux team number.
+
The behaviour of foldingathome can be customized by editing {{ic|/opt/fah/config.xml}}. Some options that can be specified:
<team v='your team number'/>
+
 
*bigpackets, defines whether you will accept memory intensive work loads. If you have no problem with Folding@home using up more of your RAM, then set this to big. Other settings are normal and small.
+
* bigpackets, defines whether you will accept memory intensive work loads. If you have no problem with Folding@home using up more of your RAM, then set this to big. Other settings are normal and small.
*passkey to identify your machine. You can get one of these on the homepage. They are used to distinguish different users and/or clients.
+
* passkey, to uniquely identify you. Though not needed, it provides some measure of security. For details, see [http://folding.stanford.edu/English/FAQ-passkey]
{{ic|A passkey is not actually needed. It is only used to preserve your other stats, if a client running under your own username is going nuts and is sending wrong results!}}
+
 
  <passkey v='passkey'/>
 
  <passkey v='passkey'/>
 +
* Slots for CPU or GPU
 +
<slot id='0' type='CPU'/>
  
*Slots for CPU or GPU
+
== Multi-Core CPUs and Folding@home ==
  <slot id='0' type='CPU'/>
+
  
After editing that, run
+
As of version 7.x, multi-core CPUs no longer require any special configuration. If you are using version 6.x, read on.
# systemctl start foldingathome
+
  
to start Folding@home up.
+
=== A quick note on hyperthreading ===
  
Assuming it all ran correctly, you will want to start it when the system boots:
+
{{Accuracy|"Hyperthreading is usually enabled in the BIOS by default, and we recommend that it stays enabled, as the SMP cores can use it to process Work Units faster." [http://folding.stanford.edu/English/FAQ-SMP#ntoc6]}}
# systemctl enable foldingathome
+
  
Folding@home is now installed and running.
+
If you have a single-core hyperthreading CPU, you may be tempted to follow the multi-core instructions. It is highly recommenced that you do '''not''' do this as the Folding@home team prefers fewer results quickly, than more results slowly. There is also a time-limit on work-units, so if it runs slower, your work-units may not be returned in time, and so distributed to another user. If you have one core, run one folding process.
  
== Multi-Core CPUs and Folding@home ==
+
=== Multiple Folding@home installs ===
 
+
=== A Quick Note On Hyperthreading ===
+
If you have a single-core hyperthreading CPU, you may be tempted to follow the multi-core instructions. It is highly recommenced that you '''''do not''''' do this as the Folding@home team prefers fewer results quickly, than more results slowly. There is also a time-limit on work-units, so if it runs slower, your work-units may not be returned in time, and so distributed to another user. If you have one core, run one folding process.
+
  
=== Multiple Folding@home Installs ===
+
Multiple installations of FAH on a single machine are useless, as in v7, you can use slots for every workload. The software is uniform now for GPU and CPU.
  
Multiple installations of FAH on a single machine are useless, as in v7, you can use slots for every workload. The software is uniform now for gpu and cpu.
+
== Monitoring work-unit progress ==
  
== Monitoring Work-Unit Progress ==
+
There are several ways of monitoring the progress of your FAH clients, both on the command line and by GUI.
There are several ways of monitoring the progress of your FAH client/s, both on the command line and by GUI.  
+
  
 
The FAHControl software distributed by folding at home provides you with efficient means to control remote hosts.
 
The FAHControl software distributed by folding at home provides you with efficient means to control remote hosts.
Line 68: Line 55:
 
a connection to the remote host and show you the progress in a seperate client tab.
 
a connection to the remote host and show you the progress in a seperate client tab.
  
In AUR there is silent blades [https://aur.archlinux.org/packages.php?do_Details=1&ID=7788&O=0&L=&C=&K=folding&SB=&SO=&PP=&do_MyPackages=&do_Orphans=&SeB= fahmon], which provides a GUI with the ability to watch multiple clients and get info on the work-unit itself. Fahmon has a dedicated site at [http://www.fahmon.net/ http://www.fahmon.net/]
+
In AUR there is {{AUR|fahmon}}, which provides a GUI with the ability to watch multiple clients and get info on the work-unit itself. Fahmon has a dedicated site at [http://www.fahmon.net/ http://www.fahmon.net/]
  
On the CLI, you can add a command to your .bashrc , .zshrc or .whateverrc :
+
On the CLI, you can add a command to your shell configuration file (e.g: ''.bashrc'' or ''.zshrc''). Replace ''fah_user'' with the actual user first.
  
fahstat() {
+
{{bc|
echo
+
fahstat() {
echo `date`
+
        echo
echo
+
        echo $(date)
cat /opt/fah/FAH_USER/unitinfo.txt   #(replacing FAH_USER first)
+
        echo
}
+
        cat /opt/fah/''fah_user''/unitinfo.txt
 +
}
 +
}}
  
 
Or for multiple clients :
 
Or for multiple clients :
  
 +
{{bc|
 
  fahstat() {
 
  fahstat() {
 
         echo
 
         echo
         echo `date`
+
         echo $(date)
 
         echo
 
         echo
         echo "Core 1:";cat /opt/fah/FAH_USER/unitinfo.txt     #(replace FAH_USER first)
+
         echo "Core 1:";cat /opt/fah/''fah_user''/unitinfo.txt
 
         echo
 
         echo
         echo "Core 2:";cat /opt/fah2/FAH_USER/unitinfo.txt     #(replace FAH_USER first)
+
         echo "Core 2:";cat /opt/fah2/''fah_user''/unitinfo.txt
 
  }
 
  }
 +
}}
 +
 +
Also, replacing {{ic|cat}} with {{ic|tail -n1}} will give just the percentage of work unit complete.
  
Also, replacing cat with tail -n1 will give just the percentage of work unit complete.
+
On foldingathome-smp 6.43, the ''unitinfo.txt'' file is not placed inside the user folder. The correct directory would be {{ic|/opt/fah-smp/unitinfo.txt}}.
  
On foldingathome-smp 6.43, the unitinfo.txt file is not placed inside the user folder. The correct directory would be {{ic|/opt/fah-smp/unitinfo.txt}}.
+
== See also ==
  
== External Resources ==
+
* Folding@home [http://folding.stanford.edu/ site]  
*Folding@home [http://folding.stanford.edu/ Site]  
+
* Folding@home [http://folding.stanford.edu/English/FAQ FAQ]  
*Folding@home [http://folding.stanford.edu/English/FAQ FAQ]  
+
* Folding@home [http://folding.stanford.edu/English/FAQ-Configure configuration FAQ]
*Folding@home [http://folding.stanford.edu/English/FAQ-Configure Configuration FAQ]
+
* Folding@home  [http://folding.stanford.edu/English/FAQ-SMP SMP client FAQ]
*Folding@home Client in the [https://aur.archlinux.org/packages/foldingathome/ AUR]  
+
* Arch Folding@home [http://fah-web.stanford.edu/cgi-bin/main.py?qtype=teampage&teamnum=45032 team page]
*Folding@home  [http://folding.stanford.edu/English/FAQ-SMP SMP Client FAQ]
+
* Extended Arch team statistics in [http://folding.extremeoverclocking.com/team_summary.php?s=&t=45032 extremeoverclocking.com]
*Arch Folding@home [http://vspx27.stanford.edu/cgi-bin/main.py?qtype=teampage&teamnum=45032 team page]
+
*Extended Arch team statistics in [http://folding.extremeoverclocking.com/team_summary.php?s=&t=45032 extremeoverclocking.com]
+

Revision as of 21:44, 9 July 2013

From the project home page:

Help Stanford University scientists studying Alzheimer's, Huntington's, Parkinson's, and many cancers by simply running a piece of software on your computer. The problems we are trying to solve require so many calculations, we ask people to donate their unused computer power to crunch some of the numbers. In just 5 minutes... Add your computer to over 333,684 others around the world to form the world's largest distributed supercomputer.

Installation

Install foldingathomeAUR from the AUR.

Configuration

Run /opt/fah/FAHClient --configure as root to generate a configuration file at /opt/fah/config.xml. (the Arch Linux team number is 45032) Alternately, you can write opt/fah/config.xml by hand and use /opt/fah/sample-config.xml as a reference. With a config file in place, you can start the daemon, check it's status, and make the daemon automatically start at boot time:

# systemctl start foldingathome
$ systemctl status foldingathome
# systemctl enable foldingathome

The graphical way

You can manage the daemon by opening a web browser and heading to http://localhost:7396/. Alternately, you can install fahcontrolAUR and use the FAHControl program.

The daemon can also be controlled remotely. Instructions for doing so are listed in /opt/fah/sample-config.xml. Remember to open firewall ports if necessary.

The terminal way

To see the current progress of foldingathome, simply $ tail /opt/fah/log.txt.

The behaviour of foldingathome can be customized by editing /opt/fah/config.xml. Some options that can be specified:

  • bigpackets, defines whether you will accept memory intensive work loads. If you have no problem with Folding@home using up more of your RAM, then set this to big. Other settings are normal and small.
  • passkey, to uniquely identify you. Though not needed, it provides some measure of security. For details, see [1]
<passkey v='passkey'/>
  • Slots for CPU or GPU
<slot id='0' type='CPU'/>

Multi-Core CPUs and Folding@home

As of version 7.x, multi-core CPUs no longer require any special configuration. If you are using version 6.x, read on.

A quick note on hyperthreading

Tango-inaccurate.pngThe factual accuracy of this article or section is disputed.Tango-inaccurate.png

Reason: "Hyperthreading is usually enabled in the BIOS by default, and we recommend that it stays enabled, as the SMP cores can use it to process Work Units faster." [2] (Discuss in Talk:Folding@home#)

If you have a single-core hyperthreading CPU, you may be tempted to follow the multi-core instructions. It is highly recommenced that you do not do this as the Folding@home team prefers fewer results quickly, than more results slowly. There is also a time-limit on work-units, so if it runs slower, your work-units may not be returned in time, and so distributed to another user. If you have one core, run one folding process.

Multiple Folding@home installs

Multiple installations of FAH on a single machine are useless, as in v7, you can use slots for every workload. The software is uniform now for GPU and CPU.

Monitoring work-unit progress

There are several ways of monitoring the progress of your FAH clients, both on the command line and by GUI.

The FAHControl software distributed by folding at home provides you with efficient means to control remote hosts. Just add another client with the corresponding button "Add" and enter the name, ip address, port and password (if you set one) and hit save. The software should now try to establish a connection to the remote host and show you the progress in a seperate client tab.

In AUR there is fahmonAUR, which provides a GUI with the ability to watch multiple clients and get info on the work-unit itself. Fahmon has a dedicated site at http://www.fahmon.net/

On the CLI, you can add a command to your shell configuration file (e.g: .bashrc or .zshrc). Replace fah_user with the actual user first.

fahstat() {
        echo
        echo $(date)
        echo
        cat /opt/fah/fah_user/unitinfo.txt
}

Or for multiple clients :

 fahstat() {
         echo
         echo $(date)
         echo
         echo "Core 1:";cat /opt/fah/fah_user/unitinfo.txt
         echo
         echo "Core 2:";cat /opt/fah2/fah_user/unitinfo.txt
 }

Also, replacing cat with tail -n1 will give just the percentage of work unit complete.

On foldingathome-smp 6.43, the unitinfo.txt file is not placed inside the user folder. The correct directory would be /opt/fah-smp/unitinfo.txt.

See also