index.rst

Ahkab |release| Docs

Release:	|release|
Date:	|today|

Ahkab (pronounced "uh, cab") is an open-source SPICE-like interactive circuit simulator.

.. toctree::
   :maxdepth: 1
   :hidden:

   Homepage <https://ahkab.github.io/ahkab/>
   Repository <https://github.com/ahkab/ahkab>
   Issue Tracker <https://github.com/ahkab/ahkab/issues>

General help pages

.. toctree::
   :maxdepth: 1

   misc/A-Good-Idea
   help/Install-Notes
   help/Command-Line-Help
   help/Netlist-Syntax

Help pages on particular elements

.. toctree::
   :maxdepth: 1

   help/Mutual-Inductors

Module reference

.. toctree::
   :maxdepth: 1

   ahkab
   ac
   bfpss
   circuit
   constants
   csvlib
   dc_analysis
   dc_guess
   devices
   diode
   ekv
   gear
   implicit_euler
   mosq
   netlist_parser
   options
   plotting
   printing
   pss
   pz
   results
   shooting
   switch
   symbolic
   testing
   ticker
   transient
   trap
   utilities

Simulating from Python

.. toctree::
   :maxdepth: 1

   examples/Simple_OP
   examples/Python_API
   examples/PZ_Example

Examples of simulation from the CLI

.. toctree::
   :maxdepth: 1

   examples/OP_simulation
   examples/Transient-Example
   examples/Symbolic-simulation

License

.. toctree::
   :maxdepth: 1

   misc/COPYING

Indices and tables

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`