Simulation properties for the population class.

This class contains the simulation properties, e.g. flow, steps and max_time.

class posydon.binary_evol.simulationproperties.EvolveHooks

Bases: object

Base class for hooking into binary evolution.

post_evolve(binary)

Perform actions after a binary exits the evolution loop.

post_step(binary, step_name)

Perform acctions after every evolution step.

pre_evolve(binary)

Perform actions before a binary evolves.

pre_step(binary, step_name)

Perform actions before every evolution step.

class posydon.binary_evol.simulationproperties.PrintStepInfoHooks

Bases: posydon.binary_evol.simulationproperties.EvolveHooks

Simple example for adding extra print info.

post_evolve(binary)

Report at the end of the evolution of each binary.

pre_step(binary, step_name)

Print the step name for each binary, before taking it.

class posydon.binary_evol.simulationproperties.SimulationProperties(properties=None, **kwargs)

Bases: object

Class describing the properties of a population synthesis simulation.

Construct the simulation properties object.

Parameters

• properties (object) – Simulation Properties class containing, e.g. flow, steps.

• extra_hooks (list of tuples) – Each tuple contains a hooks class and kwargs or the extra step name (‘extra_pre_evolve’, ‘extra_pre_step’, ‘extra_post_step’, ‘extra_post_evolve’) and the corresponding function.

close()

Close hdf5 files before exiting.

load_steps(verbose=False)

Instantiate step classes and set as instance attributes.

Parameters

verbose (bool) – Print extra information.

Returns

Return type

None

post_evolve(binary)

Finalize the evolution of the binary.

The method is called after a binary exits the evolution loop. Uses all extra hooks classes or extra functions.

Parameters

binary (instance of <class, BinaryStar>) – The binary after evolution is ended.

Returns

binary

Return type

instance of <class, BinaryStar>

post_step(binary, step_name)

Finalize step.

The method is called after every evolution step; uses all extra hooks classes or extra functions (except for undefined next step errors).

Parameters

• binary (instance of <class, BinaryStar>) – The binary before evolution starts.

• step_name (str) – The name of the step about to be called (as defined in the flow).

Returns

binary

Return type

instance of <class, BinaryStar>

pre_evolve(binary)

Functions called before a binary evolves.

Uses all extra hooks classes or extra functions.

Parameters

binary (instance of <class, BinaryStar>) – The binary before evolution starts.

Returns

binary

Return type

instance of <class, BinaryStar>

pre_step(binary, step_name)

Prepare for step.

The method is called before every evolution step; uses all extra hooks classes or extra functions (except for undefined next step errors).

Parameters

• binary (instance of <class, BinaryStar>) – The binary before evolution starts.

• step_name (str) – The name of the step about to be called (as defined in the flow).

Returns

binary

Return type

instance of <class, BinaryStar>

class posydon.binary_evol.simulationproperties.StepNamesHooks

Bases: posydon.binary_evol.simulationproperties.EvolveHooks

Add history column ‘step_name’ to each binary.

Name of evolutionary step as defined in SimulationProperties.

>>> pop.to_df(extra_columns=['step_names'])

post_evolve(binary)

Ensure None’s are append to step_names to match rows in history.

post_step(binary, step_name)

Record the step name.

pre_evolve(binary)

Initialize the step name to match history.

pre_step(binary, step_name)

Do not do anything before the step.

class posydon.binary_evol.simulationproperties.TimingHooks

Bases: posydon.binary_evol.simulationproperties.EvolveHooks

Add history column ‘step_times’ (time taken by step) to each binary.

Example

>>> pop.to_df(extra_columns=['step_times'])

post_evolve(binary)

Add None’s to step_times to match history rows.

post_step(binary, step_name)

Record the duration of the step.

pre_evolve(binary)

Initialize the step time to match history.

pre_step(binary, step_name)

Record the wall time before taking the step.