Makefile Commands

The repository includes a Makefile with convenient commands for common development tasks.

Available Commands

To see the list of available commands at any time, run:

make help

Usage: make <command>

    help                 (Default) Print listing of key targets with their descriptions
    install              Install the package and all development dependencies
    rm-samples           Remove samples folder
    clean                Clean up all build, test, coverage and Python artifacts
    test                 Run the full test suite in parallel using pytest
    test-gds             Run GDS regressions tests (tests/test_pdk.py)
    test-gds-force       Run GDS regressions tests (tests/test_pdk.py) and regenerate
    test-gds-fail-fast   Run GDS regressions tests (tests/test_pdk.py) and stop at first failure
    update-pre           Update pre-commit hooks to the latest revisions
    run-pre              Run all pre-commit hooks on all files
    build                Build the Python package (install build tool and create dist)
    write-cells          Write cell outputs into documentation notebooks (used when building docs)
    write-makefile-help  Write Makefile help output to documentation
    convert-notebooks    Convert jupytext scripts from notebooks/src to ipynb format in notebooks
    copy-sample-notebooks Copy all sample scripts to use as notebooks docs
    setup-ipython-config Setup IPython configuration for documentation build
    docs                 Build the HTML documentation
    docs-latex           Setup LaTeX for PDF documentation

Usage

To run any of these commands, use:

make <command>