This document attempts to maintain a common build process for both Windows 10 and Windows 11. Note that released installers are currently always built from Windows 11 (but are believed to work on Windows 10).
The default supported Python version is 3.11. The latest binary installer for Python 3.11 on Windows can be found here:
- https://www.python.org/downloads/windows/ (e.g. https://www.python.org/ftp/python/3.11.9/python-3.11.9-amd64.exe)
By default, this will put Python 3.11 someplace like:
/c/Users/mzieg/AppData/Local/Programs/Python/Python311/python
/c/Users/mzieg/AppData/Local/Programs/Python/Python311/python/Scripts
You will need to update your Windows %PATH% to make sure those directories are high in your search order.
Other than Python, the following installation sequence is recommended:
- Git for Windows
- select "Use Git and optional Unix tools from the Command Prompt"
- InnoSetup (tested 6.0.4)
- Wasatch.PY (clone parallel to Enlighten)
- Enlighten (clone parallel to Wasatch.PY)
Windows environments have additional dependencies if you need KnowItAll support:
- KnowItAllWrapper
- a compiled copy of KIAConsole is in dist/
See MAINTENANCE for temporary changes or workarounds to the build process.
For Windows 11, you should then be able to install all Python dependencies, and run the program from source like this (assuming you've cloned ENLIGHTEN to %HOME%\work\code\enlighten):
C> cd %HOME%\work\code\enlighten
C> python scripts\bootstrap\win11\bootstrap.py
In Windows 10, the following should work (but is not tested as regularly):
C> cd %HOME%\work\code\enlighten
C> python scripts\bootstrap\win10\bootstrap.py
These are older setup instructions from before the new win11\bootstrap.py script was available. Until all development stations are fully updated and the script rigorously tested, these instructions are maintained for legacy support.
$ cd %HOME%
$ python3.11 -m venv enlighten_py311
$ enlighten_py311\Scripts\activate
You must have a copy of Wasatch.PY in a parallel directory.
$ git clone git@github.com:WasatchPhotonics/ENLIGHTEN.git
$ git clone git@github.com:WasatchPhotonics/Wasatch.PY.git
$ cd ENLIGHTEN
$ pip install requirements.txt
$ pip install pywin32 spc_spectra
$ set PYTHONPATH=..\Wasatch.PY;..\jcamp;plugins;.;enlighten\assets\uic_qrc
$ sh scripts\rebuild_resources.sh
To test ENLIGHTEN with a spectrometer, you'll need to install the libusb drivers. Normally this is done for customers when they run the ENLIGHTEN binary installer. If you're running from a source distribution, you'll need to install those drivers manually so Windows knows how to enumerate the spectrometer.
Basically, follow this...
...except when it tells you to navigate here...
C:\Program Files\Wasatch Photonics\Wasatch.NET\libusb\drivers
...instead navigate here:
enlighten\scripts\support\files\libusb\drivers
$ python scripts\Enlighten.py --help
$ python scripts\Enlighten.py
The latest recommended process is to build installers on Win11-64.
To build an installer, you need to first install all dependencies for your platform, then run this from a Git Cmd shell (will destroy and re-create venv)
$ scripts\bootstrap.bat oneshot
See scripts/dos for some convenience scripts for quickly running ENLIGHTEN from source and building installers.
Note that you can run the generated ENLIGHTEN-Setup64-x.y.z.exe installer with a /log argument, which will write a file like "Setup Log YYYY-MM-DD #001.txt" in your %TEMP% directory. This can be helpful in determining which files were installed where during the installation process.
This typically means you need to install libusb's Windows DLL in the appropriate System32 folder. Ironically, one of the easiest ways to do this is to install a previous version of ENLIGHTEN (the installer does this automatically).
Try setting this environment variable before launching ENLIGHTEN, then checking STDERR:
> set LIBUSB_DEBUG=4
If you get something like this on Windows using ENLIGHTEN 64-bit:
File "C:\Users\mzieg\miniconda3\envs\conda_enlighten3\lib\site-packages\usb\backend\libusb1.py", line 893, in ctrl_transfer ret = _check(self.lib.libusb_control_transfer( File "C:\Users\mzieg\miniconda3\envs\conda_enlighten3\lib\site-packages\usb\backend\libusb1.py", line 604, in _check raise USBError(_strerror(ret), ret, _libusb_errno[ret]) usb.core.USBError: [Errno 2] Entity not found
One option is to rename C:/Windows/System32/libusb-1.0.dll to Libusb-1.0-save.dll.
This issue should be solved by Wasatch.PY 2.0.2, which explicitly specified the libusb0 backend in calls to usb.core.find().