chipflow

Chipflow library

This is the main entry point for the ChipFlow library, providing tools for building ASIC designs using the Amaranth HDL framework.

Submodules

• chipflow.auth
• chipflow.auth_command
• chipflow.common
• chipflow.config
• chipflow.packages
• chipflow.packaging
• chipflow.platform
• chipflow.utils

Exceptions

ChipFlowError

Base exception for ChipFlow errors

Functions

ensure_chipflow_root()

Ensure CHIPFLOW_ROOT environment variable is set and return its path.

Package Contents

exception chipflow.ChipFlowError

Bases: Exception

Base exception for ChipFlow errors

chipflow.ensure_chipflow_root()

Ensure CHIPFLOW_ROOT environment variable is set and return its path.

If CHIPFLOW_ROOT is not set, sets it to the current working directory. Also ensures the root is in sys.path.

Returns:

Path to the chipflow root directory

Return type:

pathlib.Path