Reference

event_horyzen.event_horyzen
event_horyzen.animated_plot
event_horyzen.fantasy

event_horyzen.event_horyzen

Evaluate geodesics for different spacetime backgrounds.

event_horyzen.event_horyzen.cli(): CLI interface for event_horyzen module.

event_horyzen.event_horyzen.copy_default_config(dest=None)

Copy default configuration.

Parameters: dest (Union[Path, str], optional) – The destination to copy to

Examples

>>> from event_horyzen.event_horyzen import copy_default_config
>>> copy_default_config()

The above copies to your current working directory. This next example copies to a chosen location.

>>> from event_horyzen.event_horyzen import copy_default_config
>>> copy_default_config("/tmp/default-config.yml")

Or

>>> from event_horyzen.event_horyzen import copy_default_config
>>> from pathlib import Path
>>> dest = Path("/tmp/default-config.yml")
>>> copy_default_config(dest)

Return type: None

event_horyzen.event_horyzen.run(conf_path=None)

Run routine for geodesic motion simulation.

Given the configuration file(s), simulate the gedoesic(s).

Parameters: conf_path (Union[Path, str, None], optional) – The path to the YAML configuration file. If None, use default config.yml.

Examples

FIXME: Add docs.

Return type: None

event_horyzen.animated_plot

event_horyzen.fantasy

Geodesic integration module.

event_horyzen.fantasy.AutoJacob(Param, Coord, i, wrt): FIXME Add docs.

event_horyzen.fantasy.CoordTrans0(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.CoordTrans1(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.CoordTrans2(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.CoordTrans3(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.Hamil_inside(q, p, Param, wrt): FIXME Add docs.

event_horyzen.fantasy.dif(func, x): FIXME Add docs.

event_horyzen.fantasy.dm(Param, Coord, metric, wrt): FIXME Add docs.

class event_horyzen.fantasy.dual(first, second)

dual class.

FIXME Add more docs.

cos(): FIXME Add docs.

exp(): FIXME Add docs.

log(): FIXME Add docs.

sin(): FIXME Add docs.

tan(): FIXME Add docs.

event_horyzen.fantasy.g00(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g01(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g02(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g03(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g11(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g12(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g13(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g22(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g23(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.g33(Param, Coord): FIXME Add docs.

event_horyzen.fantasy.geodesic_integrator(N, delta, omega, q0, p0, Param, order=2): FIXME Add docs.

event_horyzen.fantasy.phiHA(delta, omega, q1, p1, q2, p2, Param): FIXME Add docs.

event_horyzen.fantasy.phiHB(delta, omega, q1, p1, q2, p2, Param): FIXME Add docs.

event_horyzen.fantasy.phiHC(delta, omega, q1, p1, q2, p2, Param): FIXME Add docs.

event_horyzen.fantasy.updator(delta, omega, q1, p1, q2, p2, Param): FIXME Add docs.

event_horyzen.fantasy.updator_4(delta, omega, q1, p1, q2, p2, Param): FIXME Add docs.