pyiron.table.datamining module¶
-
class
pyiron.table.datamining.
FunctionContainer
[source]¶ Bases:
object
Class which is able to append, store and retreive a set of functions.
-
class
pyiron.table.datamining.
PyironTable
(project, name=None)[source]¶ Bases:
object
Class for easy, efficient, and pythonic analysis of data from pyiron projects
- Parameters
project (pyiron.project.Project/None) – The project to analyze
name (str) – Name of the pyiron table
-
property
db_filter_function
¶ Function to filter the a project database table before job specific functions are applied.
The function must take a pyiron project table in the pandas.DataFrame format (project.job_table()) and return a boolean pandas.DataSeries with the same number of rows as the project table
Example
- def function(df):
return (df[“chemicalformula”==”H2”]) & (df[“hamilton”==”Vasp”])
-
property
filter
¶ Object containing pre-defined filter functions
- Returns
The object containing the filters
- Return type
-
property
filter_function
¶ Function to filter each job before more expensive functions are applied
-
property
name
¶ Name of the table. Takes the project name if not specified
- Returns
Name of the table
- Return type
str
-
class
pyiron.table.datamining.
TableJob
(project, job_name)[source]¶ Bases:
pyiron.base.job.generic.GenericJob
-
property
add
¶
-
property
analysis_project
¶
-
property
convert_to_object
¶
-
property
db_filter_function
¶
-
property
enforce_update
¶
-
property
filter
¶
-
property
filter_function
¶
-
from_hdf
(hdf=None, group_name=None)[source]¶ Restore pyiron table job from HDF5
- Parameters
hdf –
group_name –
-
property
project_level
¶
-
property
pyiron_table
¶
-
property
ref_project
¶
-
to_hdf
(hdf=None, group_name=None)[source]¶ Store pyiron table job in HDF5
- Parameters
hdf –
group_name –
-
update_table
(job_status_list=None)[source]¶ Update the pyiron table object, add new columns if a new function was added or add new rows for new jobs
- Parameters
job_status_list (list/None) – List of job status which are added to the table by default [“finished”]
-
property