.. include:: abbreviation.txt
.. include:: project-links.txt
.. raw:: html
.. raw:: html
###########################################################################
Simulate Electronic Circuit using Python and the Ngspice / Xyce Simulators
###########################################################################
.. image:: /_static/logo.png
:alt: PySpice logo
:width: 750
********
Overview
********
PySpice is a free and open source (*) Python module which interface |Python|_ to the |Ngspice|_ and
|Xyce|_ circuit simulators.
|Ngspice|_ is a fork of the famous `SPICE
`_ circuit simulator,
while |Xyce|_ is a SPICE compatible simulator developed by the `Sandia National Laboratories
`_.
.. rst-class:: small-text
(*) PySpice is licensed under GPLv3 therms.
PySpice implements a Ngspice binding and provides an oriented object API on top of SPICE, the
simulation output is converted to |Numpy|_ arrays for convenience.
PySpice requires Python 3 and works on Linux, Windows and OS X.
:ref:`To read more on PySpice `
.. raw:: html
.. rst-class:: clearfix row
.. rst-class:: column column2
:ref:`news-page`
================
What's changed in versions
.. rst-class:: column column2
:ref:`Installation-page`
========================
How to install PySpice on your system
.. rst-class:: column column2
:ref:`user-faq-page`
====================
Answers to frequent questions
.. rst-class:: column column2
:ref:`examples-page`
====================
Many examples to learn how to use PySpice. To learn more on how to run theses examples, read the
:ref:`introduction to the examples `.
.. rst-class:: column column2
:ref:`development-page`
=======================
How to contribute to the project
.. rst-class:: column column2
:ref:`reference-manual-page`
============================
Technical reference material, for classes, methods, APIs, commands.
.. rst-class:: column column2
:ref:`how-to-refer-page`
========================
Guidelines to cite PySpice
.. rst-class:: column column2
:ref:`donate-page`
==================
If you want to donate to the project or need a more professional support.
.. raw:: html
.. why here ???
.. rst-class:: clearfix row
.. raw:: html
*******************
Table of Contents
*******************
.. toctree::
:maxdepth: 3
:numbered:
overview.rst
news.rst
roadmap.rst
installation.rst
simulators.rst
faq.rst
example-introduction.rst
examples/index.rst
example-whish-list.rst
design-notes.rst
reference-manual.rst
development.rst
how-to-refer.rst
donate.rst
on-the-web.rst
related-projects.rst
bibliography.rst
.. End