pyiron.base.server.generic module¶
-
class
pyiron.base.server.generic.
Server
(host=None, queue=None, cores=1, threads=1, run_mode='modal', new_hdf=True)[source]¶ Bases:
pyiron.base.generic.template.PyironObject
Generic Server object to handle the execution environment for the job
- Parameters
host (str) – hostname of the local machine
queue (str) – queue name of the currently selected queue
cores (int) – number of cores
run_mode (pyiron.base.server.runmode.Runmode) – mode of the job [‘modal’, ‘non_modal’, ‘queue’, ‘manual’]
new_hdf (bool) – create a new HDF5 file [True/False] - default=True
-
.. attribute:: send_to_db
boolean option to decide which jobs should be store in the external/public database.
-
.. attribute:: structure_id
the structure ID to be linked to an external/public database.
-
.. attribute:: host
the hostname of the current system.
-
.. attribute:: queue
the que selected for a current simulation.
-
.. attribute:: cores
the number of cores selected for the current simulation.
-
.. attribute:: run_time
the run time in seconds selected for the current simulation.
-
.. attribute:: run_mode
the run mode of the job [‘modal’, ‘non_modal’, ‘queue’, ‘manual’]
-
.. attribute:: new_hdf
defines whether a subjob should be stored in the same HDF5 file or in a new one.
-
property
accept_crash
¶
-
property
cores
¶ The number of cores selected for the current simulation
- Returns
number of cores
- Return type
(int)
-
db_entry
()[source]¶ connect all the info regarding the server into a single word that can be used e.g. as entry in a database
- Returns
server info as single word
- Return type
(str)
-
from_hdf
(hdf, group_name=None)[source]¶ Recover Server object in HDF5 file
- Parameters
hdf – HDF5 object
group_name – node name in the HDF5 file
-
static
list_queues
()[source]¶ List the available Job scheduler provided by the system.
- Returns
(list)
-
property
memory_limit
¶
-
property
new_hdf
¶ New_hdf5 defines whether a subjob should be stored in the same HDF5 file or in a new one.
- Returns
[True / False]
- Return type
(bool)
-
property
queue
¶ The que selected for a current simulation
- Returns
schedulers_name
- Return type
(str)
-
property
queue_id
¶ Get the queue ID - the ID in the queuing system is most likely not the same as the job ID.
- Returns
queue ID
- Return type
int
-
property
queue_list
¶ List the available Job scheduler provided by the system.
- Returns
(list)
-
property
queue_view
¶ List the available Job scheduler provided by the system.
- Returns
(pandas.DataFrame)
-
property
run_mode
¶ Get the run mode of the job
- Returns
[‘modal’, ‘non_modal’, ‘queue’, ‘manual’]
- Return type
(str/pyiron.base.server.runmode.Runmode)
-
property
run_time
¶ The run time in seconds selected for the current simulation
- Returns
run time in seconds
- Return type
(int)
-
property
send_to_db
¶ Get the boolean option to decide which jobs should be store in the external/public database
- Returns
[True/False]
- Return type
bool
-
property
structure_id
¶ Get the structure ID to be linked to an external/public database
- Returns
structure ID
- Return type
int
-
property
threads
¶