https://github.com/ap--/python-seabreeze
Python module for OceanOptics spectrometers
https://github.com/ap--/python-seabreeze
hacktoberfest python-seabreeze spectrometers spectroscopy
Last synced: 18 days ago
JSON representation
Python module for OceanOptics spectrometers
- Host: GitHub
- URL: https://github.com/ap--/python-seabreeze
- Owner: ap--
- License: mit
- Created: 2014-10-16T23:30:21.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T12:16:31.000Z (6 months ago)
- Last Synced: 2024-10-29T12:44:40.879Z (6 months ago)
- Topics: hacktoberfest, python-seabreeze, spectrometers, spectroscopy
- Language: C++
- Homepage: https://python-seabreeze.readthedocs.io
- Size: 8.65 MB
- Stars: 211
- Watchers: 17
- Forks: 82
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Python module for [Ocean Optics](http://www.oceanoptics.com/) spectrometers
[](https://anaconda.org/conda-forge/seabreeze)
[](https://pypi.org/project/seabreeze/)
[](https://github.com/ap--/python-seabreeze/actions/workflows/run_test_build_deploy.yaml)
[](https://github.com/ap--/python-seabreeze/releases)
[](https://pypi.org/project/seabreeze/)
[](http://opensource.org/licenses/MIT)
[](https://github.com/ap--/python-seabreeze/issues)
[](https://zenodo.org/badge/latestdoi/25327268)
[](https://github.com/sponsors/ap--)
Python-seabreeze is the easy way to access your Ocean Optics spectrometers from
python. It wraps the [SeaBreeze](http://oceanoptics.com/product/seabreeze/)
library provided by Ocean Optics to communicate with the spectrometer. It also
provides a pyUSB based reimplementation of SeaBreeze for easy extension.
**This software is not associated with Ocean Optics. Use it at your own risk.**
## DOCUMENTATION ON RTD
You'll find the documentation and more detailed information here
[https://python-seabreeze.readthedocs.io/en/latest/](https://python-seabreeze.readthedocs.io/en/latest/)
## Changes
The changelog can be found here [CHANGELOG.md](https://github.com/ap--/python-seabreeze/blob/master/CHANGELOG.md)
## Install
```bash
# via pypi
pip install seabreeze
seabreeze_os_setup
```
or
```bash
# via conda
conda install -c conda-forge seabreeze
seabreeze_os_setup
```
### Using the backend pyseabreeze in Windows
The backend pyseabreeze requires the libraries pyusb and libusb
```bash
# via pypi
pip install seabreeze[pyseabreeze] # this ensures installation of pyusb
```
Additionally, you might need to manually install libusb1. Go here https://libusb.info/, Downloads -> Latest Windows Binaries. In the zip file, enter either the folder MinGW64/dll or MinGW32/dll (depending on your OS). Copy the file `libusb-1.0.dll` into `C:\Windows\System32`.
## Usage
The following example shows how simple it is to acquire a spectrum with
python-seabreeze through the model independent _Spectrometer_ class. For a more
detailed description read the [documentation](https://python-seabreeze.readthedocs.io/en/latest/):
```python
>>> from seabreeze.spectrometers import Spectrometer
>>> spec = Spectrometer.from_first_available()
>>> spec.integration_time_micros(20000)
>>> spec.wavelengths()
array([ 340.32581 , 340.70321186, 341.08058305, ..., 1024.84940994,
1025.1300678 , 1025.4106617 ])
>>> spec.intensities()
array([ 1.58187931e+01, 2.66704852e+04, 6.80208103e+02, ...,
6.53090172e+02, 6.35011552e+02, 6.71168793e+02])
```
To use the pyseabreeze backend (requires `pyusb`) simply run this before importing `seabreeze.spectrometers`.
```python
>>> import seabreeze
>>> seabreeze.use('pyseabreeze')
>>> import seabreeze.spectrometers as sb
```
## Supported Devices
| Spectrometer | cseabreeze | pyseabreeze (usb) | pyseabreeze (ethernet) |
|:-------------|:----------:|:----------------------:|:----------------------:|
| HR2000 | x | x | |
| HR2000PLUS | x | x | |
| HR4000 | x | x | |
| JAZ | x | x | |
| MAYA2000 | x | x | |
| MAYA2000PRO | x | x | |
| MAYALSL | x | x | |
| NIRQUEST256 | x | x | |
| NIRQUEST512 | x | x | |
| QE65000 | x | x | |
| QE-PRO | x | x | |
| STS | x | x | |
| TORUS | x | x | |
| USB2000 | x | x | |
| USB2000PLUS | x | x | |
| USB4000 | x | x | |
| USB650 | | [Issue #47][issue47] | |
| SPARK | x | x | |
| ADC1000 | | x | |
| HDX | | [Issue #133][issue133] | x |
| HR2 | | x | |
| HR4 | | x | |
| HR6 | | x | |
| SR2 | | x | |
| SR4 | | x | |
| SR6 | | x | |
| ST-VIS | | x | |
[issue47]: https://github.com/ap--/python-seabreeze/issues/47
[issue133]: https://github.com/ap--/python-seabreeze/issues/133
## Reading spectra via ethernet
This functionality is currently implemented for the HDX with the pyseabreeze backend.
The following example shows how to read a spectrum via ethernet:
```pycon
>>> import seabreeze
... from seabreeze.spectrometers import Spectrometer
...
... seabreeze.use("pyseabreeze", network_adapter="192.168.254.200")
>>>
>>> spec = Spectrometer.from_serial_number("HDX12345")
>>> spec.intensities()
array([1967.07287765, 1325.69702018, 1418.40732539, ..., 1398.4680335 ,
1406.44364585, 1397.47109175])
```
## Known Issues
- USB2000 spectrometers cause `Data transfer error` due to old firmware [Issue #48](https://github.com/ap--/python-seabreeze/issues/48)
- USB650 not supported [Issue #47](https://github.com/ap--/python-seabreeze/issues/47)
- No conda packages for armv6 (RPI version 1) [Issue #46](https://github.com/ap--/python-seabreeze/issues/46)
## Contributing Guidelines
If you run into any problems, file an issue and be sure to include the
following in your report:
- Operating system (Linux distribution, Windows version, OSX version) and
archictecture (32bit, 64bit, arm)
- Python version and arch (i.e. Python 2.7.10 64bit)
- python-seabreeze version
If you want a feature implemented, please file an issue, or create a pull
request when you implement it yourself. And if you would like to support me via
paypal, click on the paypal donate button on top of this README.
## License
Files in this repository are released under the [MIT license](LICENSE.md).
## Related Repositories
If you want me to add your project here, let me know. Happy to add it.
- [python-seatease by @jonathanvanschenck](https://github.com/jonathanvanschenck/python-seatease) - a software emulator of python-seabreeze. Emulates seabreeze's behavior so for testing my code without access to a spectrometer.
- [python-seabreeze-server by @jonathanvanschenck](https://github.com/jonathanvanschenck/python-seabreeze-server) - a TCP-based server to host the seabreeze.cseabreeze backend, allowing multiple clients (potentially offsite) to interact with a single spectrometer.
- [SeaBreeze](https://sourceforge.net/projects/seabreeze/) - Ocean Optics' SeaBreeze C library.
- [libseabreeze](https://github.com/ap--/libseabreeze) - github clone of the C library. _internal use only_ (has pre-built libraries if you know what you're doing)
- [python-seabreeze-feedstock](https://github.com/ap--/python-seabreeze) - anaconda feedstock for automated package deployment. _internal use only_
- [yaqd-seabreaeze](https://gitlab.com/yaq/yaqd-seabreeze) - A seabreeze interface for the [yaq instrument control framework](https://yaq.fyi)
- [HTTP bindings](https://gitlab.com/hololinked-examples/oceanoptics-spectrometer) - customizable HTTP interface in python along with Web of Things compatibility and ZMQ transport. Based on [hololinked](https://github.com/VigneshVSV/hololinked)