Merge pull request #52 from VektrexElectronicSystems/development-sandbox

Development sandbox v1.8.0

Author: eljayg

README.md

@@ -21,6 +21,8 @@ Download and install [Python](https://www.python.org/downloads/), which will ins
 - Python Launcher  
 - Python3 Interpreter
 
+It is recommended to use a version of Python with the status key of bugfix or higher, see [Python Release Cycle](https://devguide.python.org/versions/#versions).
+
 #### Windows Setup
 
 ##### Use the Standard Console Command Prompt
@@ -30,7 +32,7 @@ To open Command Prompt press the key combination Windows + R to open a Run dialo
 It is recommended that the path of Python Interpreter is added for easy usage. There are two ways to add Python to Windows PATH.
 
 1. During Python installation check the box Add Python to PATH when prompted.
-   - Confirm Python PATH is set in **Command Prompt** by typing `python3 --version` to verify the Python version
+   - Confirm Python PATH is set in **Command Prompt** by typing `py --version` to verify the Python version
 
 2. Manually add Python to Windows Path:
    - Press the key combination **Windows + R** to open a Run dialog
@@ -44,7 +46,7 @@ It is recommended that the path of Python Interpreter is added for easy usage. T
      - Navigate to the **scripts** folder (this is the `Python Scripts path`)
      - Set the Path **Variable value** to `Python application path;Python Scripts path` (paths are separated by a semicolon)
    - Press **OK**
-   - Confirm Python PATH is set in **Command Prompt** by typing `python3 --version` to verify the Python version
+   - Confirm Python PATH is set in **Command Prompt** by typing `py --version` to verify the Python version
 
 #### Mac OS X Setup
 
@@ -65,7 +67,12 @@ It is recommended that the path of Python Interpreter is added for easy usage. T
 ### IDEs
 
 #### Visual Studio Code and Using a Virtual Environment
-To run these sequences a light-weight IDE, or to target cross-platform development, use the free [Visual Studio Code](https://code.visualstudio.com/). See [Getting Started with Python in VS Code](https://code.visualstudio.com/docs/python/python-tutorial) to simply setup your IDE with Python. Optionally, using a [virtual environment](https://docs.python.org/3/tutorial/venv.html) is recommended to successfully meet the installation requirements to run these sequences. Using the commands `python3 -m venv .venv` followed by `.venv\scripts\activate` is a simple way to setup your virtual environment. After your IDE and virtual environment is setup, continue to install the remaining Python packages below.
+To run these sequences a light-weight IDE, or to target cross-platform development, use the free [Visual Studio Code](https://code.visualstudio.com/). See [Getting Started with Python in VS Code](https://code.visualstudio.com/docs/python/python-tutorial) to simply setup your IDE with Python. Optionally, using a [virtual environment](https://docs.python.org/3/tutorial/venv.html) is recommended to successfully meet the installation requirements to run these sequences. To setup your virtual environment run the follow commands and then continue to install the remaining Python packages later in this document:
+
+| OS | Command |
+| - | - |
+| Windows | `py -m venv .venv` followed by `.venv\scripts\activate` |
+| macOS | `python3 -m venv .venv` followed by `.venv\scripts\activate` |
 
 #### Visual Studio Community
 To run these sequences in a more feature rich IDE, use the free [Visual Studio Community](https://visualstudio.microsoft.com/vs/community/). See [Python In Visual Studio](https://docs.microsoft.com/en-us/visualstudio/python/tutorial-working-with-python-in-visual-studio-step-00-installation?view=vs-2022) to simply setup your IDE with Python. Optionall, using a [virtual environment](https://docs.microsoft.com/en-us/visualstudio/python/managing-python-environments-in-visual-studio?view=vs-2022) is recommended to successfully meet the installation requirements to run these sequences.
@@ -74,31 +81,77 @@ To run these sequences in a more feature rich IDE, use the free [Visual Studio C
 
 #### Managing Packages
 ##### How to Install/Upgraded Packages
-Installing packages use pip. It is recommended that pip be updated to latest version `python3 -m pip install --upgrade pip`
+Installing packages use pip. It is recommended that pip be updated to latest version.
+
+To install/upgrade pip, run command: 
+| OS | Command |
+| - | - |
+| Windows | `py -m pip install --upgrade pip` |
+| macOS | `python3 -m pip install --upgrade pip` |
 
-The version of pip can be displayed with the following command `pip3 -V`
+To display the version of pip, run command:
+| OS | Command |
+| - | - |
+| Windows | `pip -V` |
+| macOS | `pip3 -V` |
 
 ##### How to View All Installed Packages
-A list of all installed packages can be found with `pip3 freeze` command
+A list of all installed packages can be displayed.
+
+To view all installed packages, run command:
+| OS | Command |
+| - | - |
+| Windows | `pip freeze` |
+| macOS | `pip3 freeze` |
 
 ##### How to View Details of an Installed Package
-After a package is installed the details of a package can be displayed with the following command `pip3 show <package name>` (e.g. `pip3 show spikesafe-python`)
+After a package is installed the details of a package can be displayed.
+
+To view details of a package, run command: 
+| OS | Command |
+| - | - |
+| Windows | `pip show <package name>` |
+| macOS | `pip3 show <package name>` |
 
 ##### Installing spikesafe-python Package
-The [spikesafe-python](https://pypi.org/project/spikesafe-python/) library will need to be installed using the command `python3 -m pip install spikesafe-python`. Vektrex recommends always having the latest version of spikesafe-python when running these sequences; the current version is 1.2.3.
+The [spikesafe-python](https://pypi.org/project/spikesafe-python/) library will need to be installed. Vektrex recommends always having the latest version of spikesafe-python when running these sequences; the current version is 1.3.0.
+
+To install this package, run command:
+| OS | Command |
+| - | - |
+| Windows | `py -m pip install spikesafe-python` |
+| macOS | `python3 -m pip install spikesafe-python` |
 
 Once the spikesafe-python package is installed, each script in this repository can be run independently as a standalone Python file. Run a file in its current state and verify that the expected outputs are obtained, as specified by the file's markdown description.
 
 Complete class documentation is available for spikesafe-python in [spikesafe-python API Overview](spikesafe_python_lib_docs).
 
 #### Installing matplotlib Package
-Some sequences involve graphing measurement results. To properly graph results, the [matplotlib](https://matplotlib.org/) library is required (version 3.2.1 or greater). Use the command `python3 -m pip install matplotlib` to install the latest version of matplotlib. Once the matplotlib library is installed, each sequence that involves graphing can be run as a standalone Python file.
+Some sequences involve graphing measurement results. To properly graph results, the [matplotlib](https://matplotlib.org/) library is required (version 3.2.1 or greater). Once the matplotlib library is installed, each sequence that involves graphing can be run as a standalone Python file.
+
+To install this package, run command:
+| OS | Command |
+| - | - |
+| Windows | `py -m pip install matplotlib` |
+| macOS | `python3 -m pip install matplotlib` |
 
 #### Installing PyCLibrary Package
-Some sequences require external C resources, and requires the [PyCLibrary](https://pyclibrary.readthedocs.io/en/latest/) library. To install this library, enter the command `python3 -m pip install pyclibrary`. Once the PyCLibrary library is installed, each sequence that involves external C resources can be run as a standalone Python file.
+Some sequences require external C resources, and requires the [PyCLibrary](https://pyclibrary.readthedocs.io/en/latest/) library. Once the PyCLibrary library is installed, each sequence that involves external C resources can be run as a standalone Python file.
+
+To install this package, run command:
+| OS | Command |
+| - | - |
+| Windows | `py -m pip install pyclibrary` |
+| macOS | `python3 -m pip install pyclibrary` |
 
 #### Installing pyserial Package
-Some sequences involve connecting to a serial interface instrument and requires the [pyserial](https://pypi.org/project/pyserial/) library (version 3.5 or greater). Use the command `python3 -m pip install pyserial` to install the latest version of pyserial. Once the pyserial library is installed, each sequence that involves a serial interface can be run as a standalone Python file.
+Some sequences involve connecting to a serial interface instrument and requires the [pyserial](https://pypi.org/project/pyserial/) library (version 3.5 or greater). Once the pyserial library is installed, each sequence that involves a serial interface can be run as a standalone Python file.
+
+To install this package, run command:
+| OS | Command |
+| - | - |
+| Windows | `py -m pip install pyserial` |
+| macOS | `python3 -m pip install pyserial` |
 
 ### General Usage
 For most examples, you may need to modify the specified IP address within a sequence to match the IP address that is physically set on your SpikeSafe's DIP switch. In each sequence, the default IP address of 10.0.0.220 is set in the line `ip_address = '10.0.0.220'`.
@@ -131,6 +184,9 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
 I'm developing an application using NI-VISA, what is the recommended practice for handling termination characters?<br />
 See [Termination Characters in NI-VISA](https://www.ni.com/en-us/support/documentation/supplemental/06/termination-characters-in-ni-visa.html)
 
+I'm developing an application using MATLAB, how do I get started?<br />
+See [System Requirements for MATLAB Engine API for Python](https://www.mathworks.com/help/matlab/matlab_external/system-requirements-for-matlab-engine-for-python.html) to ensure your system can support Python. Then see [Call Python from MATLAB](https://www.mathworks.com/help/matlab/call-python-libraries.html) on how to access Python libraries in MATLAB.
+
 ## Support/Feedback
 
 If any further assistance is needed beyond the information provided within this repository, email [email protected].