Skip to content

Commit

Permalink
Merge branch 'master' of github.com:FabriceSalvaire/PySpice
Browse files Browse the repository at this point in the history
  • Loading branch information
FabriceSalvaire committed Feb 22, 2017
2 parents 33eddfd + 7e2e5d9 commit 254a7d1
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions doc/sphinx/source/examples.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
Examples
==========

This section gives an overwiew of what we can do with PySpice. These examples are inspired from
This section gives an overview of what we can do with PySpice. These examples are inspired from
classical circuits and can serve as learning materials.

.. warning:: The PDF generated by the Sphinx documentation generator could be poorly formatted.

Usually these examples don't involve advanced Python programming. You just need to know basic Python
programming and how to use the Numpy and Matplotlib framework. However the code to make complexe
programming and how to use the Numpy and Matplotlib framework. However the code to make complex
figures can require advanced Matplotlib topics.

---------------------
Expand All @@ -28,17 +28,17 @@ Some links to learn about Python programming and Scientific Framework:
* `Python Scientific Lecture Notes <https://scipy-lectures.github.io/>`_
* `Scientific Python Lectures <http://nbviewer.ipython.org/github/jrjohansson/scientific-python-lectures/tree/master/>`_

----------------------------
How to Run theses Examples
----------------------------
---------------------------
How to Run these Examples
---------------------------

A Linux desktop is the best platform to work with PySpice. Indeed it is easier to get NgSpice
running and install Python.

There is several ways to run the examples: as a script from the console, in the Ipython interactive
There are several ways to run the examples: as a script from the console, in the Ipython interactive
environment or in a web browser using the Ipython Notebook. Each has their advantages and drawbacks.
A script is best when we want to work on a file using an editor. And an interactive environment is
best when we want to play with code in live.
A script is best when we want to work on a file using an editor, and an interactive environment is
best when we want to play with code live.

To run an example from the console, execute this command:

Expand Down Expand Up @@ -66,7 +66,7 @@ To start the IPython notebook in your web browser:
ipython notebook
When we use IPython notebook it is convenient to use a matplotlib backend that outputs the graphics
When we use IPython notebook, it is convenient to use a matplotlib backend that outputs the graphics
embedded in the notebook file. To activate this backend, somewhere in the beginning on the notebook,
you must add:

Expand All @@ -78,11 +78,11 @@ Then you can copy-paste code blocks and execute them.

.. warning::

Notice for security reason, web browsers don't offer a simple way to copy-paste a code block,
Notice that for security reason, web browsers don't offer a simple way to copy-paste a code block,
i.e. fill the clipboard using a button and some javascript behind the scene (Github and others use a hack
based on Flash to achieve this).

You must select and copy by hand the code.
You must select and copy the code by hand.

------------------------
How to Write a Netlist
Expand All @@ -99,7 +99,7 @@ way. You could also use a sketcher like |Kicad|_ and export the netlist to SPICE
This documentation is automatically generated from the Python examples using the tool
*generate-rst-examples* located in the source in the *tools* directory.

This tool walk recursively through the *examples* directory and process the Python files.
This tool walks recursively through the *examples* directory and processes the Python files.

A typical Python file contains such lines::

Expand Down

0 comments on commit 254a7d1

Please sign in to comment.