Skip to content

Commit

Permalink
Original version by Michael Caverley
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasc-ubc committed Nov 15, 2015
1 parent 2aa41d3 commit 6bc907a
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 0 deletions.
52 changes: 52 additions & 0 deletions pyOptomip/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
The license agreement for the pyOptomip software package is shown below:

-------------------------------------

The MIT License (MIT)

Copyright (c) 2015 Michael Caverley

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

-------------------------------------

This software contains some derivative work from other software packages.
The copyright notices for these software packages are below.

-------------------------------------
matplotlib


1. This LICENSE AGREEMENT is between the Matplotlib Development Team (“MDT”), and the Individual or Organization (“Licensee”) accessing and otherwise using matplotlib software in source or binary form and its associated documentation.

2. Subject to the terms and conditions of this License Agreement, MDT hereby grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce, analyze, test, perform and/or display publicly, prepare derivative works, distribute, and otherwise use matplotlib 1.4.3 alone or in any derivative version, provided, however, that MDT’s License Agreement and MDT’s notice of copyright, i.e., “Copyright (c) 2012-2013 Matplotlib Development Team; All Rights Reserved” are retained in matplotlib 1.4.3 alone or in any derivative version prepared by Licensee.

3. In the event Licensee prepares a derivative work that is based on or incorporates matplotlib 1.4.3 or any part thereof, and wants to make the derivative work available to others as provided herein, then Licensee hereby agrees to include in any such work a brief summary of the changes made to matplotlib 1.4.3.

4. MDT is making matplotlib 1.4.3 available to Licensee on an “AS IS” basis. MDT MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, MDT MAKES NO AND DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB 1.4.3 WILL NOT INFRINGE ANY THIRD PARTY RIGHTS.

5. MDT SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF MATPLOTLIB 1.4.3 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING MATPLOTLIB 1.4.3, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.

6. This License Agreement will automatically terminate upon a material breach of its terms and conditions.

7. Nothing in this License Agreement shall be deemed to create any relationship of agency, partnership, or joint venture between MDT and Licensee. This License Agreement does not grant permission to use MDT trademarks or trade name in a trademark sense to endorse or promote products or services of Licensee, or any third party.

8. By copying, installing or otherwise using matplotlib 1.4.3, Licensee agrees to be bound by the terms and conditions of this License Agreement.

-------------------------------------
59 changes: 59 additions & 0 deletions pyOptomip/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
Installation instructions:

1. Download Anaconda 32 bit (Python 2.7):

Download from: http://continuum.io/downloads

2. Install pyvisa:

In a command prompt, run
pip install pyvisa

3. Install wxpython 32 bit for Python 2.7:

Download from: http://www.wxpython.org/download.php

4. Install comtypes

In a command prompt, run
pip install comtypes

Instructions for running the GUI software:

Option 1: To run from within Spyder, add the pyOptomip folder to the PYTHONPATH. Then, run the pyOptomip.pyw script.

Option 2: To run as a standalone application, set the file association so that pyOptomip.pyw opens with pythonw.exe (found in C:\Anaconda). This
is the preferred way of running the program.

Instrument connection instructions:

To connect the instruments, first select the instrument you want to connect from the top dropdown menu. Then select the address (GPIP, serial etc.)
and enter the other parameters for the instrument. Press connect to initiate a connection to the instruments. The instruments can be connected in any
order.

Specific instructions for connecting each instrument:

Laser: hp816x
Select the GPIB address for the laser in the "GPIB address" combo box, then press connect.

Laser: hp816x_N77Det
Select the GPIB address for the 816x mainframe in the "Mainframe Address" combo box, then select the USB or GPIB VISA address for the N77xx detector in the
"Detector Address" combo box. Push connect in order to connect to both the mainframe and the detector.

Stage: Corvus Eco
Select the serial port that the stage is connected to using the "Serial Port" combo box. For example, if the stage is connected to serial port COM3, the VISA
address will be "ASRL3::INSTR". Then, enter the number of axes that your setup uses. If your stage uses three axes (i.e. x, y, and z for moving the fiber array
up and down), enter 3 into the "Number of Axis" box. If your setup only uses two axes (i.e., only x ad y), then enter 2. Finally, push connect in order to connect
to the stages.

Stage: Thorlabs BBD203
Enter the serial number for each of the stages, then push connect. A window will pop up with motor controls. Do not close this window.

Known issues:

When using hp816x_N77Det, if there are any detectors plugged into the 8163 or 8164 mainframe, the detectors listed on the Instrument Control
window will not correspond to the labels on the detectors. This can cause unexpected sweep measurement results. The workaround is to unplug
all detectors from the mainframe when using the N77xx detectors.

When not using the N77xx detector, if there is a detector plugged into the mainframe which stores less than 20001 datapoints (e.g. 81634A),
then stitching will not work.

0 comments on commit 6bc907a

Please sign in to comment.