| 1 | = Job keywords = |
| 2 | |
| 3 | [DesignKeywords Keywords] describe the attributes of jobs, such as: |
| 4 | * The area of science it contributes to |
| 5 | * The location of the research group that submitted it. |
| 6 | |
| 7 | Keywords are used for various purposes in BOINC, such as |
| 8 | * Informational: volunteers can see job keywords in the BOINC Manager |
| 9 | and on the project web site. |
| 10 | * Preferences: volunteers can express preferences for keywords, |
| 11 | which limits what jobs are sent to the volunteer. |
| 12 | Currently this is supported in the account manager architecture; |
| 13 | it would also be possible to support it at the project level. |
| 14 | |
| 15 | == Keyword headers == |
| 16 | |
| 17 | Keywords are identified by permanent integer IDs, and also by symbols mapped to these IDs. |
| 18 | The current list of keywords can be obtained as: |
| 19 | |
| 20 | * [https://boinc.berkeley.edu/keywords.php an XML file] |
| 21 | * [https://boinc.berkeley.edu/keywords.php?header=python a Python header file] |
| 22 | * [https://boinc.berkeley.edu/keywords.php?header=c a C header file] |
| 23 | * [https://boinc.berkeley.edu/keywords.php?header=bash a Bash header file ] |
| 24 | * [https://boinc.berkeley.edu/keywords.php?header=php a PHP header file ] |
| 25 | |
| 26 | == Keywords in job submission == |
| 27 | |
| 28 | The [JobSubmission job submission interfaces] let you associate keywords with jobs. |
| 29 | |
| 30 | == Keyword scheduling == |
| 31 | |
| 32 | If you include |
| 33 | {{{ |
| 34 | <keyword_sched/> |
| 35 | }}} |
| 36 | in your project's config.xml, score-based scheduling will include a keyword component: |
| 37 | if a volunteer has a "no" preference for keyword X, |
| 38 | they won't be sent jobs with keyword X, |
| 39 | and if they have a "yes" preference, |
| 40 | they will preferentially be sent jobs with that keyword. |
| 41 | |
| 42 | == Project keywords == |
| 43 | |
| 44 | You can also associate keywords with your project as a whole. |
| 45 | Do this by creating a file "project_keywords.xml" in the project root directory. |
| 46 | This file has the format |
| 47 | {{{ |
| 48 | <project_keywords> |
| 49 | <keyword> |
| 50 | <id>4</id> |
| 51 | { <work_fraction>.7</work_fraction> } |
| 52 | </keyword> |
| 53 | ... |
| 54 | </project_keywords> |
| 55 | }}} |
| 56 | |
| 57 | Include <work_fraction> if not all jobs have that keyword. |
| 58 | The number express what fraction of your project's work (measured in FLOPs) |
| 59 | have that keyword. |