This repository has been archived by the owner on Mar 4, 2023. It is now read-only.
/
Queue.py
84 lines (71 loc) · 2.78 KB
/
Queue.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
from abaqusConstants import *
class Queue:
"""A Queue object tells the job where and how to submit a job remotely. A Queue object can
be used as the *queue* argument to the Job method.
Notes
-----
This object can be accessed by:
.. code-block:: python
import job
session.queues[name]
"""
def __init__(
self,
name: str,
queueName: str,
hostName: str = "",
fileCopy: Boolean = ON,
directory: str = "",
driver: str = "",
remotePlatform: SymbolicConstant = "Linux",
filesToCopy: str = ALL,
deleteAfterCopy: Boolean = OFF,
description: str = "",
):
"""This method creates a Queue object.
Note:Remote queues are available only on Linux platforms.
Notes
-----
This function can be accessed by:
.. code-block:: python
session.Queue
Parameters
----------
name
A String specifying the name of the new Queue object.
queueName
A String specifying the name of the remote analysis queue.
hostName
A String specifying the name of the remote host. The default value is an empty string.
fileCopy
A Boolean specifying if the results files are to be copied from the remote machine to
the local machine. The default value is ON.
directory
A String specifying the remote location for the execution of the simulation. The default
value is an empty string.
driver
A String specifying the designation of the remote driver. The default value is "abaqus".
remotePlatform
A SymbolicConstant specifying the type of operating system on the remote machine. The
default value is Linux.
filesToCopy
A list of Strings specifying the files to be copied from the remote location to the
local machine, or ALL. Strings specified in a list are the extensions of the job files
that will be copied, such as ('log', 'dat', 'msg', 'sta', 'odb'). The default value is
ALL.
deleteAfterCopy
A Boolean specifying whether remote files are to be deleted after they are copied to the
local machine. The default value is OFF.
description
A String specifying a description of the queue. The default value is an empty string.
Returns
-------
A Queue object.
Raises
------
- If *fileCopy*=ON and *hostName* is empty:
Remote queue host name is not set.
- If *fileCopy*=ON and *directory* is empty:
Directory in which to run the job on the remote computer is not set.
"""
pass