diff --git a/2.4-dev/.doctrees/environment.pickle b/2.4-dev/.doctrees/environment.pickle index 5081524102..1d238b0bcd 100644 Binary files a/2.4-dev/.doctrees/environment.pickle and b/2.4-dev/.doctrees/environment.pickle differ diff --git a/2.4-dev/restapi/index.html b/2.4-dev/restapi/index.html index 76499a0c3f..fc604bac23 100644 --- a/2.4-dev/restapi/index.html +++ b/2.4-dev/restapi/index.html @@ -694,7 +694,7 @@ "properties" : { "action_failure_cause" : { "type" : "string", - "description" : "The action's failure cause (or the empty string if no failure)." + "description" : "the action's failure cause (or the empty string if no failure)." }, "wrench_api_request_success" : { "type" : "boolean", @@ -711,7 +711,7 @@ "properties" : { "action_name" : { "type" : "string", - "description" : "The new action's name." + "description" : "the new action's name." }, "uses_scratch" : { "type" : "number", @@ -719,7 +719,7 @@ }, "num_bytes_to_read" : { "type" : "string", - "description" : "The num of bytes the action's to read." + "description" : "the num of bytes the action's to read." }, "wrench_api_request_success" : { "type" : "boolean", @@ -752,11 +752,11 @@ "properties" : { "parent_action_name" : { "type" : "string", - "description" : "Name of the parent action." + "description" : "the name of the parent action." }, "child_action_name" : { - "type" : "File", - "description" : "Name of the child action." + "type" : "string", + "description" : "the name of the child action." } } }; @@ -764,27 +764,27 @@ "properties" : { "name" : { "type" : "string", - "description" : "Name of compute action." + "description" : "the name of compute action." }, "flops" : { "type" : "float", - "description" : "Amount of flops." + "description" : "amount of flops" }, "ram" : { "type" : "float", - "description" : "Amount of ram needed." + "description" : "amount of ram needed." }, "max_num_cores" : { "type" : "long", - "description" : "Maximum amount of cores." + "description" : "maximum amount of cores." }, "min_num_cores" : { "type" : "long", - "description" : "Minimum amount of cores." + "description" : "minimum amount of cores." }, "parallel_model" : { "type" : "tuple", - "description" : "Info for making parallel model as a (string, float) tuple. The string is the parallel model type, which can be AMDAHL or CONSTANTEFFICIENCY. Each model takes a float parameter between 0.0 and 1.0. The AMDAHL model's parameter denotes the fraction of the sequential execution time that is perfectly parallelizable. The CONSTANTEFFICIENCY model's parameter is simply the parallel efficiency" + "description" : "Specification of a parallel model as a (string, float) tuple. The string is the parallel model type, which can be AMDAHL or CONSTANTEFFICIENCY. Each model takes a float parameter between 0.0 and 1.0. The AMDAHL model's parameter denotes the fraction of the sequential execution time that is perfectly parallelizable. The CONSTANTEFFICIENCY model's parameter is simply the parallel efficiency" } } }; @@ -792,11 +792,11 @@ "properties" : { "name" : { "type" : "string", - "description" : "Name of file copy action." + "description" : "the name of file copy action." }, "file_name" : { - "type" : "File", - "description" : "File object." + "type" : "string", + "description" : "the name of the file to copy." }, "src_storage_service_name" : { "type" : "StorageService", @@ -812,11 +812,11 @@ "properties" : { "name" : { "type" : "string", - "description" : "Name of file delete action." + "description" : "the name of file delete action." }, "file_name" : { - "type" : "File", - "description" : "File object to be deleted." + "type" : "string", + "description" : "the name of the file to delete." }, "storage_service_name" : { "type" : "StorageService", @@ -828,11 +828,11 @@ "properties" : { "name" : { "type" : "string", - "description" : "Name of file write action." + "description" : "the name of file write action." }, "file_name" : { - "type" : "File", - "description" : "File object to write to." + "type" : "string", + "description" : "the name of the file to write." }, "storage_service_name" : { "type" : "StorageService", @@ -844,7 +844,7 @@ "properties" : { "parent_compound_job" : { "type" : "string", - "description" : "Name of parent compound job." + "description" : "the name of parent compound job." } } }; @@ -852,7 +852,7 @@ "properties" : { "name" : { "type" : "string", - "description" : "Name of sleep action." + "description" : "the name of sleep action." }, "sleep_time" : { "type" : "string", @@ -864,7 +864,7 @@ "properties" : { "compute_service_name" : { "type" : "string", - "description" : "The compute service's name" + "description" : "the compute service's name" }, "service_specific_args" : { "$ref" : "#/components/schemas/simulationsimidstandardJobsjob_namesubmit_service_specific_args" @@ -933,19 +933,19 @@ "properties" : { "name" : { "type" : "string", - "description" : "Name of the action" + "description" : "the name of the action" }, "file_name" : { "type" : "string", - "description" : "Name of the file to read" + "description" : "the name of the file to read" }, "storage_service_name" : { "type" : "string", - "description" : "Name of the storage service the file is stored in" + "description" : "the name of the storage service the file is stored in" }, "num_bytes_to_read" : { "type" : "number", - "description" : "Number of bytes to read from the file" + "description" : "number of bytes to read from the file" } } }; @@ -954,11 +954,11 @@ "properties" : { "file_name" : { "type" : "string", - "description" : "Name of the file in the entry" + "description" : "the name of the file in the entry" }, "storage_service_name" : { "type" : "string", - "description" : "Name of the storage service in the entry" + "description" : "the name of the storage service in the entry" } } }; @@ -967,7 +967,7 @@ "properties" : { "size" : { "type" : "number", - "description" : "The file's size in bytes." + "description" : "the file's size in bytes." }, "wrench_api_request_success" : { "type" : "boolean", @@ -983,7 +983,7 @@ "properties" : { "file_name" : { "type" : "string", - "description" : "The name of the file in the entry" + "description" : "the name of the file in the entry" } } }; @@ -1024,14 +1024,14 @@ "properties" : { "hostnames" : { "type" : "array", - "description" : "The service's compute hosts", + "description" : "the service's compute hosts", "items" : { "type" : "string" } }, "flop_rates" : { "type" : "array", - "description" : "The service's compute hosts' flop rates", + "description" : "the service's compute hosts' flop rates", "items" : { "type" : "number" } @@ -1042,14 +1042,14 @@ "properties" : { "hostnames" : { "type" : "array", - "description" : "The service's compute hosts", + "description" : "the service's compute hosts", "items" : { "type" : "string" } }, "flop_rates" : { "type" : "array", - "description" : "The service's compute hosts' core counts", + "description" : "the service's compute hosts' core counts", "items" : { "type" : "integer" } @@ -1061,7 +1061,7 @@ "properties" : { "job_name" : { "type" : "string", - "description" : "The new job's name." + "description" : "the new job's name." }, "wrench_api_request_success" : { "type" : "boolean", @@ -1077,7 +1077,7 @@ "properties" : { "compute_service_name" : { "type" : "string", - "description" : "The compute service's name" + "description" : "the compute service's name" }, "service_specific_args" : { "$ref" : "#/components/schemas/simulationsimidstandardJobsjob_namesubmit_service_specific_args" @@ -1093,7 +1093,7 @@ }, "service_name" : { "type" : "string", - "description" : "The new service's name (if success)" + "description" : "the new service's name (if success)" }, "failure_cause" : { "type" : "string", @@ -1105,7 +1105,7 @@ "properties" : { "filename" : { "type" : "string", - "description" : "The file name" + "description" : "the file name" } } }; @@ -1113,11 +1113,11 @@ "properties" : { "num_cores" : { "type" : "integer", - "description" : "The required number of cores" + "description" : "the required number of cores" }, "ram_memory" : { "type" : "number", - "description" : "The required memory in bytes" + "description" : "the required memory in bytes" }, "property_list" : { "$ref" : "#/components/schemas/simulationsimidaddBareMetalComputeService_property_list" @@ -1131,7 +1131,7 @@ "properties" : { "filename" : { "type" : "string", - "description" : "The file name" + "description" : "the file name" } } }; @@ -1139,7 +1139,7 @@ "properties" : { "head_host" : { "type" : "string", - "description" : "name of the (simulated) host on which the compute service should run" + "description" : "the name of the (simulated) host on which the compute service should run" }, "resources" : { "type" : "object", @@ -1161,7 +1161,7 @@ "properties" : { "head_host" : { "type" : "string", - "description" : "name of the (simulated) host on which the compute service should run" + "description" : "the name of the (simulated) host on which the compute service should run" }, "resources" : { "type" : "object", @@ -1183,7 +1183,7 @@ "properties" : { "head_host" : { "type" : "string", - "description" : "name of the (simulated) host on which the compute service should run" + "description" : "the name of the service's head host" }, "resources" : { "type" : "object", @@ -1205,7 +1205,7 @@ "properties" : { "head_host" : { "type" : "string", - "description" : "The service's head host" + "description" : "the name of the service's head host" } } }; @@ -1213,7 +1213,7 @@ "properties" : { "name" : { "type" : "string", - "description" : "name of the file" + "description" : "the name of the file" }, "size" : { "type" : "integer", @@ -1225,11 +1225,11 @@ "properties" : { "head_host" : { "type" : "string", - "description" : "The service's head host" + "description" : "the name of the service's head host" }, "mount_points" : { "type" : "array", - "description" : "The service's mount points", + "description" : "the service's mount points", "items" : { "type" : "string" } @@ -1241,7 +1241,7 @@ "increment" : { "type" : "number", "description" : "Increment in seconds.", - "format" : "integer" + "format" : "float" } } }; @@ -1249,7 +1249,7 @@ "properties" : { "name" : { "type" : "string", - "description" : "Name of Compound job" + "description" : "the name of Compound job" } } }; @@ -1257,39 +1257,39 @@ "properties" : { "json_string" : { "type" : "str", - "description" : "Workflow JSON string" + "description" : "WfFormat JSON string" }, "reference_flop_rate" : { "type" : "str", - "description" : "Reference flop rate" + "description" : "reference flop rate" }, "ignore_machine_specs" : { "type" : "bool", - "description" : "Ignore machine specs" + "description" : "ignore machine specs" }, "ignore_redundant_dependencies" : { "type" : "bool", - "description" : "Redundant dependencies" + "description" : "redundant dependencies" }, "ignore_cycle_creating_dependencies" : { "type" : "bool", - "description" : "Ignore cycle creating dependencies" + "description" : "ignore cycle creating dependencies" }, "min_cores_per_task" : { "type" : "integer", - "description" : "Min cores per task" + "description" : "min cores per task" }, "max_cores_per_task" : { "type" : "integer", - "description" : "Max cores per task" + "description" : "max cores per task" }, "enforce_num_cores" : { "type" : "bool", - "description" : "Enforce num cores" + "description" : "enforce num cores" }, "ignore_avg_cpu" : { "type" : "bool", - "description" : "Ignore average cpu" + "description" : "ignore average cpu" }, "show_warnings" : { "type" : "bool", @@ -1307,7 +1307,7 @@ }, "controller_hostname" : { "type" : "string", - "description" : "Name of the host in the simulated platform that runs the simulation execution_controller" + "description" : "the name of the host in the simulated platform that runs the simulation execution_controller" } } }; @@ -1316,7 +1316,7 @@ "properties" : { "port_number" : { "type" : "integer", - "description" : "Port number to which all subsequent HTTP requests should be sent" + "description" : "a port number to which all subsequent HTTP requests should be sent" }, "wrench_api_request_success" : { "type" : "boolean", @@ -1400,7 +1400,7 @@ }, "state" : { "type" : "number", - "description" : "A state as an integer" + "description" : "a state as an integer" }, "failure_cause" : { "type" : "string", @@ -1433,7 +1433,7 @@ "properties" : { "workflow_name" : { "type" : "string", - "description" : "Name of the workflow to which the task is being added" + "description" : "the name of the workflow to which the task is being added" }, "name" : { "type" : "string", @@ -1441,22 +1441,22 @@ }, "flops" : { "type" : "number", - "description" : "The task's floating operations per second", + "description" : "the task's floating operations per second", "format" : "number" }, "min_num_cores" : { "type" : "number", - "description" : "The task's minimum number of cores", + "description" : "the task's minimum number of cores", "format" : "unsigned long" }, "max_num_cores" : { "type" : "number", - "description" : "The task's maximum number of cores", + "description" : "the task's maximum number of cores", "format" : "unsigned long" }, "memory" : { "type" : "number", - "description" : "The task's memory requirement", + "description" : "the task's memory requirement", "format" : "number" } } @@ -1466,7 +1466,7 @@ "properties" : { "bottom_level" : { "type" : "number", - "description" : "The task's bottom-level." + "description" : "the task's bottom-level." }, "wrench_api_request_success" : { "type" : "boolean", @@ -1483,7 +1483,7 @@ "properties" : { "cores" : { "type" : "number", - "description" : "The task's minimum/maximum number of cores." + "description" : "the task's minimum/maximum number of cores." }, "wrench_api_request_success" : { "type" : "boolean", @@ -1500,7 +1500,7 @@ "properties" : { "flops" : { "type" : "number", - "description" : "The task's flops." + "description" : "the task's flops." }, "wrench_api_request_success" : { "type" : "boolean", @@ -1537,7 +1537,7 @@ "properties" : { "memory" : { "type" : "number", - "description" : "The task's memory requirement in bytes." + "description" : "the task's memory requirement in bytes." }, "wrench_api_request_success" : { "type" : "boolean", @@ -1554,7 +1554,7 @@ "properties" : { "number_of_children" : { "type" : "number", - "description" : "The task's number of children." + "description" : "the task's number of children." }, "wrench_api_request_success" : { "type" : "boolean", @@ -1570,7 +1570,7 @@ "properties" : { "file" : { "type" : "string", - "description" : "The file's ID" + "description" : "the file's ID" } } }; @@ -1578,7 +1578,7 @@ "properties" : { "file" : { "type" : "string", - "description" : "The file's ID" + "description" : "the file's ID" } } }; @@ -1591,7 +1591,7 @@ }, "time" : { "type" : "number", - "description" : "A simulated date" + "description" : "a simulated date" }, "failure_cause" : { "type" : "string", @@ -1608,7 +1608,7 @@ }, "vm_name" : { "type" : "string", - "description" : "The new VM's name (if success)" + "description" : "the new VM's name (if success)" }, "failure_cause" : { "type" : "string", @@ -1625,7 +1625,7 @@ }, "workflow_name" : { "type" : "string", - "description" : "The new workflow's name (if success)" + "description" : "the new workflow's name (if success)" }, "failure_cause" : { "type" : "string", @@ -1642,18 +1642,18 @@ }, "workflow_name" : { "type" : "string", - "description" : "The new workflow's name (if success)" + "description" : "the new workflow's name (if success)" }, "tasks" : { "type" : "array", - "description" : "The names of the workflow's tasks", + "description" : "the names of the workflow's tasks", "items" : { "type" : "string" } }, "files" : { "type" : "array", - "description" : "The names of the workflow's files", + "description" : "the names of the workflow's files", "items" : { "type" : "string" } @@ -1968,7 +1968,7 @@
Compound_job_name_addActionDependency_body *body = ; // Input to create an action dependency.
String *simid = simid_example; // ID of the simulation
-String *compoundJobName = compoundJobName_example; // Name of the compound job
+String *compoundJobName = compoundJobName_example; // the name of the compound job
WRENCHApi *apiInstance = [[WRENCHApi alloc] init];
@@ -2032,7 +2032,7 @@ Usage and SDK Samples
var api = new WrenchRestApi.WRENCHApi()
var body = ; // {{Compound_job_name_addActionDependency_body}} Input to create an action dependency.
var simid = simid_example; // {{String}} ID of the simulation
-var compoundJobName = compoundJobName_example; // {{String}} Name of the compound job
+var compoundJobName = compoundJobName_example; // {{String}} the name of the compound job
var callback = function(error, data, response) {
if (error) {
@@ -2065,7 +2065,7 @@ Usage and SDK Samples
var apiInstance = new WRENCHApi();
var body = new Compound_job_name_addActionDependency_body(); // Compound_job_name_addActionDependency_body | Input to create an action dependency.
var simid = simid_example; // String | ID of the simulation
- var compoundJobName = compoundJobName_example; // String | Name of the compound job
+ var compoundJobName = compoundJobName_example; // String | the name of the compound job
try
{
@@ -2090,7 +2090,7 @@ Usage and SDK Samples
$api_instance = new Swagger\Client\ApiWRENCHApi();
$body = ; // Compound_job_name_addActionDependency_body | Input to create an action dependency.
$simid = simid_example; // String | ID of the simulation
-$compoundJobName = compoundJobName_example; // String | Name of the compound job
+$compoundJobName = compoundJobName_example; // String | the name of the compound job
try {
$result = $api_instance->addActionDependency($body, $simid, $compoundJobName);
@@ -2109,7 +2109,7 @@ Usage and SDK Samples
my $api_instance = WWW::SwaggerClient::WRENCHApi->new();
my $body = WWW::SwaggerClient::Object::Compound_job_name_addActionDependency_body->new(); # Compound_job_name_addActionDependency_body | Input to create an action dependency.
my $simid = simid_example; # String | ID of the simulation
-my $compoundJobName = compoundJobName_example; # String | Name of the compound job
+my $compoundJobName = compoundJobName_example; # String | the name of the compound job
eval {
my $result = $api_instance->addActionDependency(body => $body, simid => $simid, compoundJobName => $compoundJobName);
@@ -2131,7 +2131,7 @@ Usage and SDK Samples
api_instance = swagger_client.WRENCHApi()
body = # Compound_job_name_addActionDependency_body | Input to create an action dependency.
simid = simid_example # String | ID of the simulation
-compoundJobName = compoundJobName_example # String | Name of the compound job
+compoundJobName = compoundJobName_example # String | the name of the compound job
try:
# Add a dependency between two actions in a compound job.
@@ -2184,7 +2184,7 @@ Parameters
- Name of the compound job
+ the name of the compound job
Coming Soon!
Simid_addBatchComputeService_body *body = ; // Input to start a new service.
+ Simid_addBatchComputeService_body *body = ; // input to start a new service.
String *simid = simid_example; // ID of the simulation
WRENCHApi *apiInstance = [[WRENCHApi alloc] init];
@@ -2781,7 +2781,7 @@ Usage and SDK Samples
var WrenchRestApi = require('wrench_rest_api');
var api = new WrenchRestApi.WRENCHApi()
-var body = ; // {{Simid_addBatchComputeService_body}} Input to start a new service.
+var body = ; // {{Simid_addBatchComputeService_body}} input to start a new service.
var simid = simid_example; // {{String}} ID of the simulation
var callback = function(error, data, response) {
@@ -2813,7 +2813,7 @@ Usage and SDK Samples
{
var apiInstance = new WRENCHApi();
- var body = new Simid_addBatchComputeService_body(); // Simid_addBatchComputeService_body | Input to start a new service.
+ var body = new Simid_addBatchComputeService_body(); // Simid_addBatchComputeService_body | input to start a new service.
var simid = simid_example; // String | ID of the simulation
try
@@ -2837,7 +2837,7 @@ Usage and SDK Samples
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\ApiWRENCHApi();
-$body = ; // Simid_addBatchComputeService_body | Input to start a new service.
+$body = ; // Simid_addBatchComputeService_body | input to start a new service.
$simid = simid_example; // String | ID of the simulation
try {
@@ -2855,7 +2855,7 @@ Usage and SDK Samples
use WWW::SwaggerClient::WRENCHApi;
my $api_instance = WWW::SwaggerClient::WRENCHApi->new();
-my $body = WWW::SwaggerClient::Object::Simid_addBatchComputeService_body->new(); # Simid_addBatchComputeService_body | Input to start a new service.
+my $body = WWW::SwaggerClient::Object::Simid_addBatchComputeService_body->new(); # Simid_addBatchComputeService_body | input to start a new service.
my $simid = simid_example; # String | ID of the simulation
eval {
@@ -2876,7 +2876,7 @@ Usage and SDK Samples
# create an instance of the API class
api_instance = swagger_client.WRENCHApi()
-body = # Simid_addBatchComputeService_body | Input to start a new service.
+body = # Simid_addBatchComputeService_body | input to start a new service.
simid = simid_example # String | ID of the simulation
try:
@@ -2934,7 +2934,7 @@ Parameters