topo_metrics.paths#

Attributes#

Functions#

get_project_root(→ pathlib.Path)

Returns the project root directory.

get_project_src(→ pathlib.Path)

Returns the path to the src directory located at the project root.

get_data_dir(→ pathlib.Path)

Returns the path to the data directory located at the project root.

instantiate_julia(→ None)

Initialises Julia, activates the environment, and imports RingStatistics.

Module Contents#

topo_metrics.paths.jl[source]#
topo_metrics.paths.RingStatistics = None[source]#
topo_metrics.paths.get_project_root() pathlib.Path[source]#

Returns the project root directory.

topo_metrics.paths.get_project_src() pathlib.Path[source]#

Returns the path to the src directory located at the project root.

topo_metrics.paths.get_data_dir() pathlib.Path[source]#

Returns the path to the data directory located at the project root.

topo_metrics.paths.instantiate_julia() None[source]#

Initialises Julia, activates the environment, and imports RingStatistics.