FAQ | This is a LIVE service | Changelog

Skip to content
Snippets Groups Projects
Commit 43f7e4fa authored by Mark Driver's avatar Mark Driver
Browse files

update documentation.

parent 22f11f41
No related branches found
No related tags found
No related merge requests found
......@@ -33,6 +33,18 @@ class Phases(object):
"""Phases class."""
def __init__(self, phase_list):
"""Initialise Phases.
Parameters
----------
phase_list : list of Phase objects.
Phases for calculation.
Returns
-------
New Phases Instance.
"""
self.phase_list = phase_list
def __eq__(self, other):
......
......@@ -36,6 +36,18 @@ LOGGER.setLevel(logging.WARN)
class SystemCollection(object):
"""System Collection class."""
def __init__(self, system_list):
"""
Parameters
----------
system_list : list of System
List of systems.
Returns
-------
None.
"""
self.system_list = system_list
def __eq__(self, other):
"""Overload equality comparison operator.
......@@ -95,6 +107,22 @@ class SystemCollection(object):
class System(object):
"""System class"""
def __init__(self, phases, runtime_information, output_information):
"""Initialise new System.
Parameters
----------
phases : Phases
Phases of interest.
runtime_information : RuntimeInformation
Runtime parameter information.
output_information : OutputInformation
Output option information.
Returns
-------
None.
"""
self.phases = phases
self.runtime_information = runtime_information
self.output_information = output_information
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment