.. lucipy documentation master file, created by
   sphinx-quickstart on Thu Jul 11 11:20:06 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Lucipy: The simple LUCIDAC python client
========================================

See :ref:`intro` for a beginning.

.. toctree::
   :maxdepth: 2
   :caption: Getting started
   
   intro
   installation
   dev
   usage

.. toctree::
   :maxdepth: 2
   :caption: Circuits
   
   model
   compilation
   simulation
   emulation
   example-circuits
   
.. toctree::
   :maxdepth: 2
   :caption: Hardware
   
   zeroconf
   synchc


Relevant external links
-----------------------

Public Development and Releases:

* https://github.com/anabrid/lucipy public development repo
* https://pypi.org/project/lucipy/ python package index listing
* https://anabrid.dev/docs/lucipy/ built sphinx documentation (Gitlab-CI target self-hosted)

Internal Development:

* https://lab.analogparadigm.com/lucidac/software/simplehc.py internal development repo

Links outside this document:

* https://anabrid.com/lucidac-user-manual.pdf LUCIDAC user documentation (first steps booklet)
* https://anabrid.dev/docs/hybrid-controller/ LUCIDAC firmware (API) documentation



Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`