Meta tags:
description=OpenMOLE: the model exploration software;
keywords=Scientific Workflow Engine, Distributed Computing, Cluster, Parameter Tuning, Model Exploration, Optimization, Genetic Algorithm, Design of Experiment, Sensitivity Analysis, Data Parallelism;

Headings (most frequently used words):

hook, write, file, to, default, hooks, into, display, content, advanced, usage, variable, restriction, what, is, how, plug, task, string, an, entire, csv, matrix, copy, variables, strings, conditional, hooking,

Text of the page (most frequently used words):
the (80), val (45), file (37), hook (29), are (15), can (14), int (14), #display (13), data (12), and (12), variables (11), hooks (10), task (10), from (10), that (10), results (10), you (10), csv (10), output (9), string (9), default (8), path (8), workdirectory (8), values (7), for (7), displayhook (7), openmole (6), write (6), when (6), flow (6), matrix (6), variable (6), execution (5), this (5), use (5), seq (5), all (4), some (4), their (4), save (4), workflow (4), outputs (4), only (4), which (4), with (4), value (4), condition (4), csvhook (4), appendtofilehook (4), hello (4), language (3), they (3), files (3), input (3), keyword (3), want (3), will (3), omr (3), exist (3), documentation (3), written (3), may (3), double (3), copy (3), standard (3), equivalent (3), into (3), myhook (3), mycondition (3), array (3), dir (3), header (3), define (3), community (2), explore (2), plug (2), scala (2), not (2), conceived (2), any (2), what (2), generated (2), during (2), plugged (2), different (2), used (2), there (2), one (2), end (2), executed (2), directory (2), format (2), these (2), store (2), stored (2), formatted (2), arguments (2), created (2), specific (2), each (2), method (2), appended (2), using (2), plain (2), text (2), entire (2), two (2), dimensional (2), understood (2), like (2), given (2), specified (2), displayed (2), filter (2), conditional (2), hooking (2), set (2), restriction (2), copyfilehook (2), txt (2), matrixhook (2), arrayonrow (2), true (2), list (2), note (2), content (2), advanced (2), usage (2), directsampling (2), contact, twitter, school, communication, partners, team, papers, about, join, sources, changes, development, faq, chat, forum, gui, developers, genetic, algorithms, scale, see, also, doc, capsule, source, transitions, functions, management, tasks, mute, pieces, software, generally, present, side, effects, role, compute, guarantees, deported, other, machines, introduces, mechanism, called, perform, action, available, actions, need, performed, mandatory, argument, specify, kind, let, consider, simple, means, every, time, finishes, find, calle, same, your, script, contains, produced, interface, then, open, export, json, able, directories, along, others, methods, come, properly, embedded, directly, give, required, described, corresponding, page, section, appart, provide, several, maners, combination, well, new, expanded, here, instance, expressions, between, evaluated, replaced, takes, appends, additional, optional, parameters, passed, workflows, writes, arrays, long, makes, possible, location, machine, running, whole, formed, think, redirected, built, decorators, simpler, syntax, where, restrict, hooked, subset, following, notation, function, emptytask, res, yourhookhere, conditionhook, println, strings, forces, flattening, lists, such, single, row, line, customises, receives, parameter, please, happens, doesn, col1, col2, colz, specifies, should, behaviour, dump, dataflow, append, returns, its, multiplied, scalatask, inputs, exploration, evaluation, sampling, completely, writing, how, suggest, edits, download, demo, tutorials,

Text of the page (random words):
hooks documentation tutorials demo download community hooks suggest edits documentation language content 1 default hooks 2 advanced hook usage 3 variable restriction default hooks what is a hook tasks in openmole are mute pieces of software they are not conceived to write files display values or generally present any side effects at all the role of a task is to compute some output data from their input data that s what guarantees that their execution can be deported to other machines openmole introduces a mechanism called hook to save or display results generated during the execution of a workflow hooks are conceived to perform an action on the outputs of the task they are plugged to different hooks are available for different actions that need to be performed how to plug a hook to a task the hook keyword is used to save or display results generated during the execution of a workflow there is only one mandatory argument to specify the kind of output you want hook display to display the results in the standard output note that it is completely equivalent to writing hook display or hook output display hook workdirectory path to a file to save the results in a file let s consider this simple workflow define the variable i val i val int define a task which returns its input value multiplied by 2 val hello scalatask i i 2 set inputs outputs i define an exploration task directsampling evaluation hello sampling i in 0 to 9 hook workdirectory results the hook is plugged to the end of the hello task in the directsampling which means that every time hello finishes the hook is executed at the end of the execution you will find a file calle results omr in the same directory as your script that contains all the results produced by the execution of the task in the interface you can then open this file and export it in csv or json format these default hook are able to store files and directories if some of you output variables are files there values are stored in the omr file along with the others variables default hooks openmole methods come with a default hook to save their results in a properly formatted file to use these embedded hooks you can directly give the required arguments e g the path of the created file to the hook keyword the specific arguments of the default hooks for each method when they exist are described in the corresponding documentation page in the explore section advanced hook usage appart from the default hook for each method openmole provide several hook to store results in specific maners write a string any string can be appended to a file using the hook appendtofilehook the appended string can be a combination of variables from the data flow and plain text val i val int val h appendtofilehook workdirectory path of the file txt string i to append write an entire file appendtofilehook can be used to write an entire file as well val file val file val i val int val h appendtofilehook workdirectory path to a file or dir i csv file content the path to the new file can be expanded using variables from the data flow i here for instance the variables or expressions written between are evaluated and replaced with their value write into a csv file the hook csvhook takes data from the data flow and appends it to a file formatted as csv val i val int val h csvhook workdirectory path to a file or dir i csv some additional optional parameters can be passed to the csvhook values seq i j specifies which variables from the data flow should be written in the file the default behaviour when this list is not specified is to dump all the variables from the dataflow to the file header col1 col2 colz customises the header of the csv file to be created with the string it receives as a parameter please note that this only happens if the file doesn t exist when the hook is executed arrayonrow true forces the flattening of input lists such that all list variables are written to a single row line of the csv file val i val int val j val array int val h csvhook workdirectory path to a file or dir i csv values seq i j header i j arrayonrow true write a matrix into a file some workflows may output two dimensional data which can be understood as a matrix for this the matrixhook writes matrix like data to a file val matrix val array array double val h matrixhook file csv matrix output format will be a csv file data understood as matrix are one and two dimensional arrays of double int and long hook to copy a file the copyfilehook makes it possible to copy a file or directory from the data flow to a given location on the machine running openmole val file val file val i val int val h copyfilehook file workdirectory path to copy the file i txt display variables to display a variable i from the workflow in the standard output use the hook displayhook i val i val int val j val int val h displayhook i j if no variable is specified in displayhook the whole data flow will be displayed display strings to display a string in the standard output use the displayhook string the string can be formed of plain text and or variables you can think of the displayhook as an openmole equivalent to scala s println val i val int val h displayhook the value of i is i conditional hooking you may want to filter outputs that are redirected to a hook i e do conditional hooking you can use for that the when keyword built from a hook and a condition val i val int val display displayhook the value of i is i when i 0 decorators exist for a simpler syntax conditionhook myhook mycondition is equivalent to myhook when mycondition and myhook condition mycondition where the condition can be given as a condition or a string variable restriction you may want to restrict the hooked variables to a subset like a variable filter you can use the following notation in the hook function hook yourhookhere values seq i j val i val int val j val int val k val double val task emptytask set outputs i j k task hook display values seq i j only i and j are displayed task hook workdirectory results res omr values seq j k only j and k are stored into the file language file management scala functions hooks transitions source capsule see also in the doc plug explore scale up language genetic algorithms developers gui community forum chat faq development changes sources join us about us papers team partners communication school twitter contact