pyiron.base.project.store module

class pyiron.base.project.store.ProjectStore(project, job_name)[source]

Bases: pyiron.base.job.generic.GenericJob

The ProjectStore object, is derived from the GenericJob class and allows the user to store aggregated information in an HDF5 file associated with the corresponding project. To the user the ProjectStore object behaves like a dictionary.

Parameters:
  • project – Project object (defines path where job will be created and stored)
  • job_name – name of the job (must be unique within this project path)
.. attribute:: key

keys of the ProjectStore object (like a dictionary)

.. attribute:: items

items of the ProjectStore object (like a dictionary)

.. attribute:: values

values of the ProjectStore object (like a dictionary)

.. attribute:: time_created

date when the ProjecStore object was created

.. attribute:: time_modified

date when the ProjecStore object was modified

collect_logfiles()[source]

Implement required function template - even though it is not required for this job type.

collect_output()[source]

Implement required function template - even though it is not required for this job type.

from_hdf(hdf=None, group_name=None)[source]

Restore object from hdf5 format

Parameters:
  • hdf – Optional hdf5 file, otherwise self is used.
  • group_name (str) – Optional hdf5 group in the hdf5 file.
items

a set-like object providing a view on ProjectStore’s dictionary items

keys

a set-like object providing a view on ProjectStore’s dictionary keys

run_if_lib()[source]

Internal function to handle jobs with Python based executables

Returns:Database ID of the ProjectStore object
Return type:int
time_created

Return the date when the ProjectStore object was created

Returns:the date when the ProjectStore object was created
Return type:DateTime
time_modified

Return the date when the ProjectStore object was modified

Returns:the date when the ProjectStore object was modified
Return type:DateTime
values

an object providing a view on ProjectStore’s dictionary values

write_input()[source]

Implement required function template - even though it is not required for this job type.