Updated SimPyLCHowTo and readme.rst 3

Author: JdeH

README.rst

@@ -6,14 +6,17 @@
 	**Simulate your PLC controls and controlled systems to save lots of commissioning time**
 
 PLC?
+----
 
 Real world industrial control systems DO NOT consist of a bunch of communicating sequential processes. Semaphores, threads and priority jugling are far too error prone to control anything else but a model railway. Most control systems are surprisingly simple, consisting of only one program loop that nevertheless seems to do many things in parallel and with reliable timing. Such a control system is called a PLC (Programmable Logic Controller) and all major industries rely on it. PLC's control trains, cranes, ships and your washing machine.
 
-What SimPyLC is not:
+What SimPyLC is not
+-------------------
 
 SimPyLC does not attempt to mimic any particular PLC instruction set or graphical representation like ladder logic or graphcet. There are enough tools that do. Anyone with experience in the field and an IT background knows that such archaic, bulky, hard to edit representations get in the way of clear thinking. By the way, graphcet is stateful per definition, which is the absolute enemy of safety. Though its bigger brother written in C++ according to exactly the same principles has been reliably controlling container cranes, grab unloaders and production lines for more than 20 years now, SimPyLC is FUNDAMENTALLY UNSUITABLE for controlling real world systems and should never be used as a definitive validation of anything. You're only allowed to use SimPyLC under the conditions specified in the qQuickLicence that's part of the distribution.
 
-What it is:
+What it is
+----------
 
 SimPyLC functionally behaves like a PLC or a set of interconnected PLC's and controlled systems. It is a very powerful tool to gain insight in the behaviour of real time controls and controlled systems. It allows you to force values, to freeze time, to draw timing charts and to visualize your system. This is all done in a very simple and straightforward way. But make no mistake, simulating systems in this way has a track record of reducing months of commissioning time to mere days. SimPyLC is Form Follows Function at its best, it does what it has to do in a robust no-nonsense way. Its sourcecode is tiny and fully open to understanding. The accompanying document `simpylc_howto <http://www.qquick.org/simpylc_howto>`_ condenses decenia of practical experience in control systems in a few clear design rules that can save you lots of trouble and prevent accidents. In addition to this SimPyLC can generate C code for the Arduino processor boards.
 
@@ -22,11 +25,13 @@ SimPyLC functionally behaves like a PLC or a set of interconnected PLC's and con
 
 	**SimPyLC is able to generate C code for Arduino processor boards, making Arduino development MUCH easier**
 
-So:
+So
+--
 
 Are you looking for impressive graphics: Look elsewhere. Do you want to gain invaluable insight in real time behaviour of controls and control systems with minimal effort: Use SimPyLC, curse at its anachronistic simplicity and grow to love it more and more.
 
-What's new:
+What's new
+----------
 
 - Parameter attitude added to Thing.__call__ to be able to use rotation matrix rather than Euler angles
 - Document simpylc_howto updated and renamed to pothole case
@@ -41,56 +46,26 @@ What's new:
 
 *REMARK: All complete Arduino examples were tested on the Arduino Due, since that's the one I own, but they should run on the One with only slight I/O modifications (PWM instead of true analog output, using a shift register if you run short of I/O pins etc.)*
 
-Bugs fixed:
+Bugs fixed
+----------
 
 - No known bugs currently
 
 **Bug reports and feature requests are most welcome and will be taken under serious consideration on a non-committal basis**
 
-Installing on Windows:
-
-1. Install MiniConda for Python 3.6 from https://conda.io/miniconda.html
-2. Open a command prompt
-3. Type `conda install numpy`
-4. Type `conda install pyopengl`
-5. Type `python -m pip install simpylc`
-6. Perform one of the following alternatives:
-    1. Install freeglut as explained on http://freeglut.sourceforge.net/index.php#download
-    2. Copy `SimPyLC\SimPyLC\freeglut.dll` to any directory in the Windows DLL path
-7. Optionally copy `SimPyLC\SimPyLC\QuartzMS.TTF` to `C:\\Windows\\Fonts`
-
-Installing on Linux:
-
-1. Install MiniConda for Python 3.6 from https://conda.io/miniconda.html
-2. Open a command prompt
-3. Type `conda install numpy`
-4. Type `conda install pyopengl`
-5. Type `python -m pip install simpylc`
-6. Perform one of the following alternatives:
-    1.  Install freeglut as explained on http://freeglut.sourceforge.net/index.php#download.
-    2. Type the following command sequence:
-        - `sudo apt-get update`
-        - `sudo apt-get install build-essential`
-        - `sudo apt-get install freeglut3-dev`
-
-Installing on OSX:
-
-1. Install MiniConda for Python 3.6 from https://conda.io/miniconda.html
-2. Open a command prompt
-3. Type `conda install numpy`
-4. Type `conda install pyopengl`
-5. Type `python -m pip install simpylc`
-6. Perform one of the following alternatives:
-    1. Install FreeGlut as explained on http://freeglut.sourceforge.net/index.php#download
-    2. Type `brew install freeglut`
-7. Install the XQuartz X-window system from https://www.xquartz.org
-
-Usage:
+Installation
+------------
+
+Installation for Windows, Linux and OSX is described `here <http://www.qquick.org/simpylc_howto#_Toc508123208>`_.
+
+Usage
+-----
 
 1. Go to directory SimPyLC/simulations/oneArmedRobot
 2. Click on world.py or run world.py from the command line
 
-GUI Operation:
+GUI Operation
+-------------
 
 - [LEFT CLICK] on a field or [ENTER] gets you into edit mode.
 - [LEFT CLICK] or [ENTER] again gets you out of edit mode and into forced mode, values coloured orange are frozen.
@@ -100,7 +75,8 @@ GUI Operation:
 - [WHEEL ROTATION] changes the value of a register field, without freezing it.
 
 
-For a test run of oneArmedRobot:
+For a test run of oneArmedRobot
+-------------------------------
 
 1. Enter setpoints in degrees for the joint angles (e.g. torAngSet for the torso of the robot) on the movement control page.
 2. After that set 'go' to 1 and watch what happens.
@@ -112,7 +88,8 @@ If you want to experiment yourself, read `SimPyLCHowTo <http://www.qquick.org/si
 
 		**Coding is text oriented, enabling simple and fast editing, but functional behaviour resembles circuit logic, with elements like markers, timers, oneshots, latches and registers**
 
-Other packages you might like:
+Other packages you might like
+-----------------------------
 
 - Lean and mean Python to JavaScript transpiler featuring multiple inheritance https://pypi.python.org/pypi/Transcrypt
 - Multi-module Python source code obfuscator https://pypi.python.org/pypi/Opy

SimPyLC/base.py

@@ -29,7 +29,7 @@
 from inspect import *
 
 programName = 'SimPyLC'
-programVersion = '3.6.16'
+programVersion = '3.6.17'
 programNameAndVersion = '{0} {1}'.format (programName, programVersion)
 programDir = os.getcwd () .replace ('\\', '/') .rsplit ('/', 3) [-1]