Merge pull request #51 from VektrexElectronicSystems/development

Development 1.7.0

Author: eljayg

README.md

@@ -15,31 +15,90 @@ Use these code samples to start learning how to communicate with your SpikeSafe
 
 ## Usage
 
+### Python
+Download and install [Python](https://www.python.org/downloads/), which will install:  
+- IDLE  
+- Python Launcher  
+- Python3 Interpreter
+
+#### Windows Setup
+
+##### Use the Standard Console Command Prompt
+To open Command Prompt press the key combination Windows + R to open a Run dialog, and then type cmd and hit Enter or click Ok.
+
+##### Add Python to PATH
+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
+
+2. Manually add Python to Windows Path:
+   - Press the key combination **Windows + R** to open a Run dialog
+   - Type `sysdm.cpl` to open the System Properties
+   - Press **Advanced** tab and then press on **Environment Variables…** to open Environment Variables dialog
+   - Under the **User variables** box, press on **New…** to add the `Path` variable (if your **Path** variable already exists, then press on **Edit…** instead):
+   - Set the Path **Variable value** to the 1) `Python application path` and 2) `Python Scripts path`. To find these paths and set the value:
+     - Type `Python` in the Windows Search Bar
+     - Right-click on the **Python App**, and then press **Open file location**
+     - Right-click on the **Python shortcut**, and then press **Open file location** (this is the `Python application path`)
+     - 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
+
+#### Mac OS X Setup
+
+##### Use the Standard Console Terminal
+To open Terminal navigate to Applications, then Utilities, then double-click the Terminal program.
+
+##### Add Python to PATH 
+It is recommended that the path of Python Interpreter is added for easy usage. To do this:
+
+- The path for Python interpreter can be found by opening **Python Launcher application** (this is the `Python install directory`)
+- Open **Terminal**
+- Type `sudo nano /etc/paths`  
+- Enter path of the `Python install directory` here  
+- Press `Control + X` to exit  
+- Press `Y` to save  
+- Confirm Python PATH is set in **Terminal** by typing `python3 --version` to verify the Python version
+
 ### 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 `py -3 -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. 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.
 
 #### 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.
 
 ### Packages
 
-#### Installing spikesafe-python Package
-The [spikesafe-python](https://pypi.org/project/spikesafe-python/) library will need to be installed using the command `python -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.
+#### 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`
+
+The version of pip can be displayed with the following command `pip3 -V`
+
+##### How to View All Installed Packages
+A list of all installed packages can be found with `pip3 freeze` command
+
+##### 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`)
+
+##### 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.
 
 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 `python -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). 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.
 
 #### 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 `python -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. 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.
 
 #### 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 `python -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). 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.
 
 ### 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'`.
@@ -67,16 +126,22 @@ First start with [TCP Socket Sample](getting_started/tcp_socket_sample) to learn
 
 We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/VektrexElectronicSystems/SpikeSafePythonSamples/tags). 
 
+## FAQ
+
+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)
+
 ## Support/Feedback
 
 If any further assistance is needed beyond the information provided within this repository, email [email protected].
 
-Feature requests and bug reports can be submitted to [the Vektrex website's support page](https://www.vektrex.com/request-support/). Select "Other" as the Product/System and enter "GitHub Repository" as the Subject.
+Feature requests and bug reports can be submitted to [the Vektrex website's support page](https://www.vektrex.com/request-support/). Select "Other" as the Product/System and enter "SpikeSafePythonSamples GitHub Repository" as the Subject.
 
 ## Contributors
 
 * **Andy Fung** - [andyfung](https://github.com/andyfung)
 * **Bill Thompson** - [BillThomp](https://github.com/BillThomp)
+* **Brad Wise** - [BradWise](https://github.com/bradwise)
 * **Eljay Gemoto** - [eljayg](https://github.com/eljayg)
 
 ## License

application_specific_examples/controlling_thermal_platform_temperature/ControllingThermalPlatformTemperature.py

@@ -16,7 +16,15 @@
 
 ### setting up sequence log
 log = logging.getLogger(__name__)
-logging.basicConfig(filename='SpikeSafePythonSamples.log',format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',datefmt='%m/%d/%Y %I:%M:%S',level=logging.INFO)
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',
+    datefmt='%m/%d/%Y %I:%M:%S',
+    handlers=[
+        logging.FileHandler("SpikeSafePythonSamples.log"),
+        logging.StreamHandler(sys.stdout)
+    ]
+)
 
 ### start of main program
 try:

application_specific_examples/fixed_pulse_count_using_software_timing/FixedPulseCountUsingSoftwareTimingExample.py

@@ -18,7 +18,15 @@
 
 ### setting up sequence log
 log = logging.getLogger(__name__)
-logging.basicConfig(filename='SpikeSafePythonSamples.log',format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',datefmt='%m/%d/%Y %I:%M:%S',level=logging.INFO)
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',
+    datefmt='%m/%d/%Y %I:%M:%S',
+    handlers=[
+        logging.FileHandler("SpikeSafePythonSamples.log"),
+        logging.StreamHandler(sys.stdout)
+    ]
+)
 
 ### start of main program
 try:

application_specific_examples/making_tj_measurements/TjMeasurement.py

@@ -73,7 +73,15 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
 
 ### setting up sequence log
 log = logging.getLogger(__name__)
-logging.basicConfig(filename='SpikeSafePythonSamples.log',format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',datefmt='%m/%d/%Y %I:%M:%S',level=logging.INFO)
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',
+    datefmt='%m/%d/%Y %I:%M:%S',
+    handlers=[
+        logging.FileHandler("SpikeSafePythonSamples.log"),
+        logging.StreamHandler(sys.stdout)
+    ]
+)
 
 ### start of main program
 try:
@@ -119,7 +127,7 @@ def calculate_Vf0(start_point, end_point, digitizer_data_list):
     input()
     log_and_print_to_console('Enter T2 (in °C):')
     temperature_two = float(receive_user_input_and_log())
-    log_and_print_to_console('Enter V2 (in °C):')
+    log_and_print_to_console('Enter V2 (in V):')
     voltage_two = float(receive_user_input_and_log())
 
     k_factor = (voltage_two - voltage_one)/(temperature_two - temperature_one)

application_specific_examples/making_transient_dual_interface_measurement/digitizer_log_sampling_demo.py

@@ -93,7 +93,7 @@ def receive_user_input_and_log():
     tcp_socket.send_scpi_command('SYST:ERR?')
     syst_err_string = tcp_socket.read_data()  
 
-    # SMU setting
+    # PSMU setting
     # set DC Dynamic mode
     tcp_socket.send_scpi_command('SOUR1:FUNC:SHAP DCDYNAMIC')
 

application_specific_examples/measuring_dc_staircase_voltages/MeasuringDcStaircaseVoltages.py

@@ -34,7 +34,15 @@
 
 ### setting up sequence log
 log = logging.getLogger(__name__)
-logging.basicConfig(filename='SpikeSafePythonSamples.log',format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',datefmt='%m/%d/%Y %I:%M:%S',level=logging.INFO)
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s.%(msecs)03d, %(levelname)s, %(message)s',
+    datefmt='%m/%d/%Y %I:%M:%S',
+    handlers=[
+        logging.FileHandler("SpikeSafePythonSamples.log"),
+        logging.StreamHandler(sys.stdout)
+    ]
+)
 
 ### start of main program
 try:

application_specific_examples/measuring_wavelength_spectrum/0048144F1.ini

@@ -0,0 +1,93 @@
+[Spectrometer]
+Description=0048144F1 - OFG-424
+Type=CAS140D
+Model=151
+Slit=100
+SerialNumber=004814417;17-4400
+Pixel=1044
+DeadPixel=10
+ActivePixel=975
+IntTimeMin=4
+IntTimeMax=65000
+DeleteIntTime=10
+Filter=2
+Shutter=2
+I2Caddress=$2E
+ADC_Bits=16
+ADC_Shift=32768
+ConfigDeviceCRC=0x00006356
+
+[ADC]
+ADC.Ref=2.5
+ADC0.Factor=-43.54
+ADC0.Offs=24.26
+
+[DensityFilter]
+0=none
+1=OD1
+2=OD2
+3=OD3
+4=OD4
+5=none
+6=none
+7=none
+
+[Wavelength Calibration]
+D0=353.13
+D1=0.51187
+D2=-2.4478E-005
+D3=-1.1034E-009
+
+[Wavelength Calibration Points]
+23.72=365.24
+101.28=404.75
+162.85=435.82
+384.15=546.08
+561.89=632.82
+694.69=696.54
+783=738.4
+836.47=763.51
+971.83=826.45
+
+[Linearity]
+c110=1.0134
+c165=1.0132
+c275=1.0126
+c440=1.0132
+c660=1.014
+c939=1.0142
+c1265=1.0145
+c1652=1.0146
+c2754=1.0141
+c3858=1.0144
+c5520=1.0129
+c7190=1.0107
+c8859=1.0101
+c11066=1.0085
+c13865=1.0064
+c16686=1.0045
+c19474=1.003
+c22309=1.0016
+c25120=1.0006
+c27944=0.99956
+c33609=0.99786
+c39178=0.99719
+c44856=0.99663
+c50452=0.99669
+c56032=0.99781
+c61445=1
+
+[Information]
+0=----------Array Detector-------------
+1=Array          : 1044 Pixel
+2=ADC            : 16 Bit
+3=Cycle Time     : 4 ms
+4=PC Interface   : CAS 100/120/140CT/140D - USB
+5= 
+6=--Flat Field Grating Spectrograph--
+7=Grating        : 400 l/mm
+8=Blaze          : 550 nm
+9=Spectral Range : ca. 1..10000 nm
+10=Order Sorting Filter : yes
+11=Shutter       : yes
+