Entrypoints and Assets

This page documents the repository-level entrypoints and packaged assets that support the main OpenPinch workflows outside the core analysis modules.

CLI and Packaged Resources

Command-line helpers for packaged OpenPinch notebook assets.

OpenPinch.__main__.build_parser()[source]

Create the CLI argument parser.

Return type:: ArgumentParser

OpenPinch.__main__.main(argv=None)[source]

Execute the OpenPinch CLI.

Parameters:: argv (list[str] | None)
Return type:: int

Helpers for accessing packaged OpenPinch sample cases and notebooks.

OpenPinch.resources.list_sample_cases()[source]

Return the packaged sample-case filenames.

Return type:: list[str]

OpenPinch.resources.list_notebooks()[source]

Return the packaged notebook filenames.

Return type:: list[str]

OpenPinch.resources.read_sample_case(name)[source]

Return the text of a packaged sample case.

Parameters:: name (str)
Return type:: str

OpenPinch.resources.copy_sample_case(name, destination)[source]

Copy a packaged sample case to destination.

Parameters:

name (str)
destination (str | Path)

Return type:

Path

OpenPinch.resources.copy_notebook(name, destination)[source]

Copy a packaged notebook to destination.

Parameters:

name (str)
destination (str | Path)

Return type:

Path

Packaged Data Assets

Packaged data assets for examples and notebooks.

Packaged sample cases for OpenPinch user workflows.

Packaged example notebooks for OpenPinch user workflows.

Streamlit App

Streamlit entry point for exploring OpenPinch analysis results.

Run with streamlit run streamlit_app.py to load the bundled demonstration case and launch the interactive dashboard defined in OpenPinch.streamlit_webviewer.web_graphing.

streamlit_app.validate_problem_path(problem_path)[source]

Stop the Streamlit app early when the configured problem file is missing.

Return type:: None

Repository Maintenance Scripts

Build the local Sphinx documentation tree.

scripts.build_docs.build_parser()[source]

Create the CLI parser for docs builds.

Return type:: ArgumentParser

scripts.build_docs.main(argv=None)[source]

Build the HTML documentation tree into docs/_build/html by default.

Parameters:: argv (list[str] | None)
Return type:: int

Build the local source and wheel distributions.

scripts.build_dist.build_parser()[source]

Create the CLI parser for distribution builds.

Return type:: ArgumentParser

scripts.build_dist.main(argv=None)[source]

Build the package into dist/ by default.

Parameters:: argv (list[str] | None)
Return type:: int

Format the repository with Ruff.

scripts.format_repo.main()[source]

Run the repository formatter through the local uv toolchain.

Return type:: int

Smoke checks for the published optional install surfaces.

scripts.optional_install_smoke.build_parser()[source]

Create the CLI parser for smoke checks.

Return type:: ArgumentParser

scripts.optional_install_smoke.main(argv=None)[source]

Run the selected smoke-check surface.

Parameters:: argv (list[str] | None)
Return type:: int

Update the project Python runtime and lockfile to the latest compatible versions.

scripts.update_toolchain.main()[source]

Refresh the pinned Python toolchain, lockfile, and synced dev env.

Return type:: int