Methods
(static) close() → {Promise}
Close a pool
see: https://computing.qarnot.com/documentation/api/#api-Pools-Close_Pool
see: https://computing.qarnot.com/documentation/api/#api-Pools-Close_Pool
Example
Usage
await Qarnot.pools.close('25b48b2e-b43b-4963-bec3-d7d112e58c81');
Returns:
- Type
- Promise
(static) create() → {Promise.<Object>}
Create a new pool
see: https://computing.qarnot.com/documentation/api/#api-Pools-Create_pool
see: https://computing.qarnot.com/documentation/api/#api-Pools-Create_pool
Examples
Usage
const pool = await Qarnot.pools.create({
name: 'my blend',
profile: 'blender',
instanceCount: 4,
snapshotWhitelist: 'white.*',
snapshotBlacklist: 'black.*',
resultsWhitelist: 'white.*',
resultsBlacklist: 'black.*',
constants : [
{
key : 'BLEND_FILE',
value : 'final.blend'
}
]
});
console.log(pool)
Output
{ uuid: 'f7cc95a3-7161-485d-ab2b-b13da6c9c0ea' }
Returns:
- Type
- Promise.<Object>
(static) delete() → {Promise}
Delete a pool
see: https://computing.qarnot.com/documentation/api/#api-Pools-Delete_Pool
see: https://computing.qarnot.com/documentation/api/#api-Pools-Delete_Pool
Example
Usage
await Qarnot.pools.delete('25b48b2e-b43b-4963-bec3-d7d112e58c81');
Returns:
- Type
- Promise
(static) get(uuid) → {Promise.<Object>}
Get information of the specified pool
see: https://computing.qarnot.com/documentation/api/#api-Pools-Pool_Information
see: https://computing.qarnot.com/documentation/api/#api-Pools-Pool_Information
Examples
Usage
const pool = await Qarnot.pools.get('62e80aae-d20a-4608-b873-ec8bff991733');
console.log(pool);
Output
{
"name": "my-pool",
"shortname": "62e80aae-d20a-4608-b873-ec8bff991733",
"creationDate": "2017-11-24T08:52:58Z",
"constants": [
{
"key": "BLEND_FILE",
"value": "qarnot.blend"
}
],
"tags": [],
"uuid": "62e80aae-d20a-4608-b873-ec8bff991733",
"instanceCount": 2,
"profile": "blender",
"resourceBuckets": [],
"status": {
"downloadProgress": 100.0,
"executionProgress": 0.0,
"uploadProgress": 0.0,
"instanceCount": 2,
"downloadTime": "00:00:00",
"downloadTimeSec": 0.0,
"environmentTime": "00:00:00",
"environmentTimeSec": 0.0,
"executionTime": "00:37:20",
"executionTimeSec": 2240.0,
"uploadTime": "00:00:00",
"uploadTimeSec": 0.0,
"wallTime": "00:19:05",
"wallTimeSec": 1145.0,
"succeededRange": "",
"executedRange": "",
"failedRange": "",
"startedOnceRange": "0-1",
"runningInstancesInfo": {
"perRunningInstanceInfo": [
{
"phase": "execution",
"instanceId": 0,
"maxFrequencyGHz": 4.0,
"currentFrequencyGHz": 3900.0,
"cpuUsage": 0.0,
"maxMemoryMB": 16384,
"currentMemoryMB": 0,
"networkInKbps": 0.0,
"networkOutKbps": 0.0,
"progress": 0.0,
"executionTimeSec": 1132.7,
"executionTimeGHz": 4368.437,
"cpuModel": "",
"activeForwards": [],
"memoryUsage": 0.0
},
{
"phase": "execution",
"instanceId": 1,
"maxFrequencyGHz": 4.0,
"currentFrequencyGHz": 3900.0,
"cpuUsage": 0.0,
"maxMemoryMB": 16384,
"currentMemoryMB": 0,
"networkInKbps": 0.0,
"networkOutKbps": 0.0,
"progress": 0.0,
"executionTimeSec": 1132.7,
"executionTimeGHz": 4368.439,
"cpuModel": "",
"activeForwards": [],
"memoryUsage": 0.0
}
],
"timestamp": "0001-01-01T00:00:00",
"averageFrequencyGHz": 3900.0,
"maxFrequencyGHz": 3900.0,
"minFrequencyGHz": 3900.0,
"averageMaxFrequencyGHz": 4.0,
"averageCpuUsage": 0.0,
"clusterPowerIndicator": 975.0,
"averageMemoryUsage": 0.0,
"averageNetworkInKbps": 0.0,
"averageNetworkOutKbps": 0.0,
"totalNetworkInKbps": 0.0,
"totalNetworkOutKbps": 0.0,
}
},
"state": "FullyExecuting"
}
Parameters:
Name | Type | Description |
---|---|---|
uuid |
String | uuid of the pool |
Returns:
- Type
- Promise.<Object>
(static) list() → {Promise.<Array.<Object>>}
Examples
Usage
const pools = await Qarnot.pools.list();
console.log(pools);
Output
[
{
"name": "my-pool",
"shortname": "62e80aae-d20a-4608-b873-ec8bff991733",
"creationDate": "2017-11-24T08:52:58Z",
"constants": [
{
"key": "BLEND_FILE",
"value": "qarnot.blend"
}
],
"tags": [],
"uuid": "62e80aae-d20a-4608-b873-ec8bff991733",
"instanceCount": 2,
"profile": "blender",
"resourceBuckets": [],
"status": {
"downloadProgress": 100.0,
"executionProgress": 0.0,
"uploadProgress": 0.0,
"instanceCount": 2,
"downloadTime": "00:00:00",
"downloadTimeSec": 0.0,
"environmentTime": "00:00:00",
"environmentTimeSec": 0.0,
"executionTime": "00:37:20",
"executionTimeSec": 2240.0,
"uploadTime": "00:00:00",
"uploadTimeSec": 0.0,
"wallTime": "00:19:05",
"wallTimeSec": 1145.0,
"succeededRange": "",
"executedRange": "",
"failedRange": "",
"startedOnceRange": "0-1",
"runningInstancesInfo": {
"perRunningInstanceInfo": [
{
"phase": "execution",
"instanceId": 0,
"maxFrequencyGHz": 4.0,
"currentFrequencyGHz": 3900.0,
"cpuUsage": 0.0,
"maxMemoryMB": 16384,
"currentMemoryMB": 0,
"networkInKbps": 0.0,
"networkOutKbps": 0.0,
"progress": 0.0,
"executionTimeSec": 1132.7,
"executionTimeGHz": 4368.437,
"cpuModel": "",
"activeForwards": [],
"memoryUsage": 0.0
},
{
"phase": "execution",
"instanceId": 1,
"maxFrequencyGHz": 4.0,
"currentFrequencyGHz": 3900.0,
"cpuUsage": 0.0,
"maxMemoryMB": 16384,
"currentMemoryMB": 0,
"networkInKbps": 0.0,
"networkOutKbps": 0.0,
"progress": 0.0,
"executionTimeSec": 1132.7,
"executionTimeGHz": 4368.439,
"cpuModel": "",
"activeForwards": [],
"memoryUsage": 0.0
}
],
"timestamp": "0001-01-01T00:00:00",
"averageFrequencyGHz": 3900.0,
"maxFrequencyGHz": 3900.0,
"minFrequencyGHz": 3900.0,
"averageMaxFrequencyGHz": 4.0,
"averageCpuUsage": 0.0,
"clusterPowerIndicator": 975.0,
"averageMemoryUsage": 0.0,
"averageNetworkInKbps": 0.0,
"averageNetworkOutKbps": 0.0,
"totalNetworkInKbps": 0.0,
"totalNetworkOutKbps": 0.0,
}
},
"state": "FullyExecuting"
}
]
Returns:
- Type
- Promise.<Array.<Object>>
(static) summaries() → {Promise.<Array.<Object>>}
List user's pool summaries
see: https://computing.qarnot.com/documentation/api/#api-Pools-List_Pool_summaries
see: https://computing.qarnot.com/documentation/api/#api-Pools-List_Pool_summaries
Examples
Usage
const summaries = await Qarnot.pools.summaries();
console.log(summaries);
Output
[
{
"name": "my-pool",
"shortname": "62e80aae-d20a-4608-b873-ec8bff991733",
"creationDate": "2017-11-24T08:52:58Z",
"uuid": "62e80aae-d20a-4608-b873-ec8bff991733",
"instanceCount": 2,
"profile": "blender",
"state": "FullyExecuting"
}
]
Returns:
- Type
- Promise.<Array.<Object>>