ChipFlow Library Documentation
==============================

``chipflow_lib`` is a Python library and tools for working with the `ChipFlow Platform <https://doc.chipflow.io>`__

It is developed at https://github.com/chipFlow/chipflow-lib/ and licensed `BSD 2-Clause <https://github.com/chipFlow/chipflow-lib/?tab=BSD-2-Clause-1-ov-file>`__

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   getting-started
   architecture
   simulation-guide
   chipflow-toml-guide
   chipflow-commands
   using-pin-signatures
   platform-api

.. toctree::
   :maxdepth: 2
   :caption: Contributor Guide

   contributor-pin-signature-internals