Exchange Family Module – cyclopts.exchange_family¶
This module defines a ProblemFamily subclass for Cyclus Resource Exchanges.
| author: | Matthew Gidden <matthew.gidden _at_ gmail.com> |
|---|
- class cyclopts.exchange_family.ResourceExchange[source]¶
A class representing families of resource exchange problems.
- read_inst(uuid, tables)[source]¶
Parameters: uuid : uuid
The uuid of the instance to read
tables : list of cyclopts_io.Table
The tables that can be written to
Returns: inst : tuple of lists of ExGroups, ExNodes, and ExArgs
A representation of a problem instance
- record_inst(inst, inst_uuid, param_uuid, species, tables)[source]¶
Parameters: inst : tuple of lists of ExGroups, ExNodes, and ExArgs
A representation of a problem instance
inst_uuid : uuid
The uuid of the instance
param_uuid : uuid
The uuid of the point in parameter space
species : str
The name of the species that generated this instance
tables : list of cyclopts_io.Table
The tables that can be written to
- record_soln(soln, soln_uuid, inst, inst_uuid, tables)[source]¶
Parameters: soln : ExSolution
A representation of a problem solution
soln_uuid : uuid
The uuid of the solution
inst : tuple of lists of ExGroups, ExNodes, and ExArgs
A representation of a problem instance
inst_uuid : uuid
The uuid of the instance
tables : list of cyclopts_io.Table
The tables that can be written to
- register_tables(h5file, prefix)[source]¶
Parameters: h5file : PyTables File
the hdf5 file
prefix : string
the absolute path to the group for tables of this family
Returns: tables : list of cyclopts_io.Tables
All tables that could be written to by this species.
- run_inst(inst, solver, verbose=False)[source]¶
Parameters: inst : tuple of lists of ExGroups, ExNodes, and ExArgs
A representation of a problem instance
solver : ProbSolver or similar
A representation of a problem solver
verbose : bool
A verbosity flag
Returns: soln : ExSolution
A representation of a problem solution
