API reference¶
The following pages document the objects exposed by waveport. Their
contents are extracted from the docstrings each time the documentation is
built.
Errors¶
- exception waveport.ParseError¶
Example data¶
- waveport.example_data_path(*parts: str) Path¶
Return the path to a file or directory in the bundled example data
The package ships the output of a few TICRA Tools models, which are handy for tutorials and tests. Pass the components of the path relative to the data directory, e.g.:
example_data_path("TICRA-models", "simple", "working", "polar_spherical.cut")
Call
example_data_path()without arguments to get the data directory itself.