V8.1 Client Guide
OUTDATED: See the new v8.3 guide
Introduction to V8 (Bastet)
We are excited to announce version 8 of the Folding@home software. V8 has been code named “Bastet” in reference to the Ancient Egyptian goddess who is associated with cats and protection from disease.
V8 is a complete rewrite of the Folding@home client software designed to make using Folding@home easier, lay a foundation for new features and to encourage community participation in the software’s continued development.
What’s New in V8?
There are several important changes in V8. First, there are now only two parts to the client software, the backend (fah-client-bastet) which runs behind the scenes handling most of the logic of running Folding@home and the frontend (fah-web-client-bastet) Web Control which provides the user interface. The v8 backend is equivalent to FAHClient in v7. The v8 Web Control combines the features of the v7 Web Control, FAHControl and FAHViewer.
Second, the concept of folding slots in v7 does not exist in v8. Instead of configuring slots you only have to tell Folding@home which compute resources (e.g. CPUs and GPUs) you would like it to use. It will then automatically allocate those resources in the most efficient way. This change both simplifies the setup of Folding@home and makes it possible for Folding@home to allocate multiple CPUs and GPUs to the same Work Unit. By allocating more resources to a single WU Folding@home can decrease simulation times and achieve scientific results more quickly.
Finally, the advanced interface FAHControl from v7 is no longer a separate application. The new Web Control aims to integrate all of the capabilities of FAHControl. In the future, v8’s Web Control will make it possible to monitor all of the machines you have contributing to F@H from one place, no matter where they are located.
Downloading the Beta Software
The v8 client is still in beta testing. We have been testing it for several months so it is in pretty good shape but there may still be some bugs and missing features. Beta releases can be found on the beta software page. You can still download stable v7 releases on the main software download page.
The v8 client can run on Windows, macOS, Linux and ARM Linux. The install procedure for v8 is essentially the same as for the v7 client with the exception that on Linux you now only need to install the fah-client package. V8 specific install instructions will be written in the near future. For now, please refer to the v7 install guides.
Using the V8 Software
The v8 Folding@home software is controlled via a web browser using Web Control. Web Control can be reached by navigating to https://app.foldingathome.org/. From this page your browser will attempt to connect to client software running on the same computer the browser is running on.
If you have installed Folding@home v8 and it is running then the Connecting… screen should disappear after a short delay and you will have access to Web Control. Note, v8 Web Control cannot be used with v7 clients.
There are four main pages in Web Control:
- Client Home Page
- Client Settings
- Log Viewer
- 3D Protein Viewer
Client Home Page
The client home page is the first screen you will encounter. After connecting, it will display the status of your F@H client. If you have not yet configured a username, team or passkey a dialog will popup asking you to do so via the Settings page or choose to fold anonymously.
Once configured, the header at the top of the page will show your username, team and the points earned so far. The buttons in the top right provide quick access to the client settings and log viewer.
Below the header, in the body of the page, is a large green button. After configuring your user settings, click this button to get going. Click it again when you want to pause folding.
Below the header is a list of active Work Units. Work Units or WUs are chunks of protein folding simulations. They represent the work assigned to your client. Each line shows the status and progress for one WU. On the right are several buttons under the Actions heading. These can be used to dump the WU or view it’s log or 3D visualization. You should only dump WUs in exceptional situations.
Below Work Units you will find information about Projects you are contributing to and Folding@home News releases.
The Settings page allows you to configure the Folding@home software on your machine. For your changes to take effect, you must click the button in the top right. Or click to discard unwanted changes.
In the User Settings section you can set your Username, Team and Passkey. These settings affect how you receive Folding@home points. More information about these settings and the points system can be found in the FAQ.
The Fold Anonymously checkbox enables anonymous folding, in which case any username, team and passkey settings will not be used.
Check the Enable Beta box if you want to contribute to projects that are in beta testing. Beta projects may be less stable and running them can in some cases negatively impact the points you earn. Running beta projects is recommended for experienced F@H contributors only.
Choose a Cause preference to tell Folding@home which cause you’d like to support the most. Folding@home will try to assign more projects supporting your preferred cause but it is not guaranteed that you will get only these projects.
Setting a Project Key is only useful in the early stages of testing F@H projects. Leave this set to zero unless instructed otherwise.
In this section, you can tell Folding@home how to use your compute resources.
Check Fold When Idle if you only want Folding@home to operate when your computer is not in use. In practice, this means that while you are moving the mouse or typing, Folding@home will not run. If your computer is setup to go to sleep when idle then Folding@home will not run at all. To use Fold When Idle effectively you may need to configure your computer to only enter sleep mode when running on battery.
The CPUs slider can be used to set the number of CPU cores Folding@home uses. You can adjust this value at any time. Setting the value too low may cause some WUs to stop running.
In the GPUs section you will find a list of the supported Graphics Processing Units available on your machine. GPU folding is the most efficient and usually earns much higher points. In some cases, folding on the GPU can slow your machine down too much. You can always disable GPU folding here. More information about GPU folding can be found in the FAQ.
In the Peers section you can add the IP addresses or hostnames of other Folding@home clients on your network. You can then control and monitor these remote clients from Web Control much like you could with FAHControl with the v7 software. However, you must configure the remote clients to allow remote access and doing so has security implications. Details on how to do so will be added later.
The Log Viewer allows you to view detailed technical information about the folding simulations running on your machine. Making sense of these logs requires expert knowledge of the Folding@home software. If you encounter a problem with F@H you may be asked to share the contents of this log file.
The Search bar can be used to filter the log for matching lines. Checking the Errors or Warnings boxes will filter the log for error and warning messages. The Reset button resets the log filters to their defaults. When Follow is enabled the log file will automatically scroll down as new information becomes available.
3D Protein Viewer
The protein viewer displays a 3D view of the protein you are simulating. You can zoom with the mouse wheel and rotate the protein by moving the mouse while holding the left button down.
The Work Unit Details panel shows some extra information about the WU. It can be moved out of the way by clicking the arrow in the top left.
There are three different modes for viewing the protein. These can be changed by clicking on the 1, 2 and 3 buttons. As the simulation progresses it will take snapshots of the protein. You can cycle through these snapshots or Frames by clicking the arrow buttons.
If you need more help with Folding@home:
- Visit the Support Page
- Ask questions at Folding Forum
- Browse previously reported issues on GitHub at fah-client-bastet or fah-web-client-bastet.
The v8 Folding@home client software is Open-Source. Anyone can get involved in improving Folding@home via our GitHub account. You can report issues, suggest new features or contribute code by visiting the v8 client’s GitHub repositories:
Only submit new issues on GitHub if you’ve fully researched the problem, gathered all the relevant information and checked that the issue does not already exist. We get many requests for new features. We can only afford to implement some of them. Ask for help before creating your first GitHub issue.
You can submit your own changes to the Folding@home software via a GitHub Pull Request (PR). PRs are much more likely to be accepted if they are simple and the code is clean and well tested.