Code Documentation: Mastml

mastml.mastml Module

This module contains routines to set up and manage the metadata for a MAST-ML run

Mastml:

Class to set up directories for saving the output of a MAST-ML run, and for constructing and updating a metadata summary file.

Functions

parallel(func, x, *args, **kwargs)

Run some function in parallel.

write_requirements()

Classes

Mastml(savepath[, mastml_metadata])

Main helper class to initialize mastml runs and create and manage run metadata

NumpyEncoder(*[, skipkeys, ensure_ascii, ...])

OrderedDict

Dictionary that remembers insertion order

Pool

alias of ProcessPool

datetime(year, month, day[, hour[, minute[, ...)

The year, month and day arguments are required.

partial

partial(func, *args, **keywords) - new function with partial application of the given arguments and keywords.

Class Inheritance Diagram

digraph inheritancee780d40bc0 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "JSONEncoder" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Extensible JSON <https://json.org> encoder for Python data structures."]; "Mastml" [URL="api/mastml.mastml.Mastml.html#mastml.mastml.Mastml",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Main helper class to initialize mastml runs and create and manage run metadata"]; "NumpyEncoder" [URL="api/mastml.mastml.NumpyEncoder.html#mastml.mastml.NumpyEncoder",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top"]; "JSONEncoder" -> "NumpyEncoder" [arrowsize=0.5,style="setlinewidth(0.5)"]; }