Portable Results — yaflux documentation

Skip to main content
`Ctrl`+`K`

# Portable Results

class yaflux._portable.Portable(parameters, results, completed_steps, step_metadata)

  Bases: `Base`

  A self-contained analysis container that can be unpickled without the original class. Preserves the step metadata and results while dropping the actual implementation.

  Attributes:
    `available_steps`

      List of all steps that were available in original analysis.

    `completed_steps`

      List all completed steps for the analysis.

    `results`

      Get the current analysis results.

  Methods

  `from_analysis`(analysis) | Create a portable version from an existing analysis.
  `get_step_info`(step_name) | Get information about a specific analysis step.
  `get_step_metadata`(step_name) | Get the metadata for a specific analysis step.
  `get_step_results`(step_name) | Get the results for a specific analysis step.
  `load`(filepath) | Load a portable analysis from a file.
  `metadata_report`() | Return the metadata for all completed steps.
  `save`(filepath[, force]) | Save the Analysis object to a file using pickle.
  `visualize_dependencies`([fontname, fontsize, ...]) | Create a clear visualization of step dependencies using Graphviz.

  property available_steps: List[str]

    List of all steps that were available in original analysis.

  classmethod from_analysis(analysis)

    Create a portable version from an existing analysis.

    Return type:

      `Portable`

  classmethod load(filepath)

    Load a portable analysis from a file.

    Overrides the base class by explicitly loading as Portable.

    Return type:

      `Portable`