irsim.config.path_param

Attributes

path_manager

Classes

PathManager

Module for managing the path of the project.

Functions

output_root(→ str)	Directory the output folders are created under.
bind(→ None)	Bind instance to default index 0 and update current alias.

Module Contents

irsim.config.path_param.output_root() → str

Directory the output folders are created under.

The folder of the running script when there is one, otherwise the current working directory: under python -c, a REPL or a notebook sys.path[0] is empty, and "" + "/figure" would point at the filesystem root.

class irsim.config.path_param.PathManager

Module for managing the path of the project.

• root_path: path of the irsim package

• ani_buffer_path: path of the animation buffer

• ani_path: path of the animation

• fig_path: path of the saved figure

The three output paths default to folders under output_root().

root_path: str

ani_buffer_path: str = '/home/docs/checkouts/readthedocs.org/user_builds/ir-sim-zh-cn-docs/checkouts/stable/docs/source/...

ani_path: str = '/home/docs/checkouts/readthedocs.org/user_builds/ir-sim-zh-cn-docs/checkouts/stable/docs/source/...

fig_path: str = '/home/docs/checkouts/readthedocs.org/user_builds/ir-sim-zh-cn-docs/checkouts/stable/docs/source/figure'

irsim.config.path_param.bind(instance: PathManager) → None

Bind instance to default index 0 and update current alias.

irsim.config.path_param.path_manager