python-seabreeze is the easy way to access your Ocean Optics spectrometers from python. It wraps the SeaBreeze library provided by Ocean Optics to communicate with the spectrometer. If SeaBreeze is not available it can fallback to a pyUSB based reimplementation.

It's recommended to read the :ref:`Installing python-seabreeze section <install-seabreeze>`, the :ref:`Quickstart Guide <quickstart>` and the :ref:`API documentation <api>`. Also check out the :ref:`Contributing Guide <contrib>` if you want to learn how to contribute to the project. A changelog is available here.

python-seabreeze module structure

python-seabreeze is used in many labs around the world. One of the cool examples was a student project measuring fluorescence spectra (#17) with a Spark spectrometer controlled by a raspberry pi zero, which was sent to the International Space Station on the SpaceX CRS-14 resupply mission. (space proof software^TM)

projects

• python-seatease by @jonathanvanschenck - 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 - a TCP-based server to host the seabreeze.cseabreeze backend, allowing multiple clients (potentially offsite) to interact with a single spectrometer.
• SeaBreeze - Ocean Optics' SeaBreeze C library.
• libseabreeze - github clone of the C library. (out-dated. has pre-built libraries if you know what you're doing)
• python-seabreeze-feedstock - anaconda feedstock for automated package deployment.
• yaqd-seabreeze - A seabreeze interface for the yaq instrument control framework
• SpectraSorter - Software for droplet sorting based on the analysis of high-speed spectrophotometer (OceanFX) measurements (written in C#, not using python-seabreeze)
• HTTP-bindings - customizable HTTP interface in python along with Web of Things compatibility and ZMQ transport. Based on hololinked.

A note from the author

ʕっ•ᴥ•ʔっ Hello everyone!

I have been maintaining this project now since 2012 and I'm always keen to learn about the different projects that python-seabreeze is used for! So please go ahead and send me an email to tell me about your science or work project! Something small like that puts a smile on my face for weeks, and is extremely motivating.

And in case python-seabreeze saved you some development time, consider contributing to the project or buying me a coffee, or support me via GitHub Sponsors.

And now let's science!

.. toctree::
   :caption: Introduction:
   :maxdepth: 3

   tldr.rst
   install.rst
   quickstart.rst
   troubleshoot.rst

.. toctree::
   :caption: Development:

   api.rst
   backend_api.rst

.. toctree::
   :caption: Support:

   contributing.rst

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`