Metadata-Version: 2.1
Name: trspectrometer
Version: 0.1.2
Summary: Software for running a time-resolved spectrometer.
Home-page: https://gitlab.com/ptapping/trspectrometer
Author: Patrick Tapping
Author-email: mail@patricktapping.com
License: UNKNOWN
Project-URL: Documentation, https://trspectrometer.readthedocs.io/
Project-URL: Source, https://gitlab.com/ptapping/trspectrometer
Project-URL: Tracker, https://gitlab.com/ptapping/trspectrometer/-/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Requires-Dist: PySide2
Requires-Dist: numpy
Requires-Dist: opencv-python-headless
Requires-Dist: tomlkit
Requires-Dist: appdirs
Requires-Dist: zarr

TRSpectrometer
==============

This software package allows the collection, viewing, and analysis of time-resolved (TR) spectroscopy data.

    **Warning**: The application is under heavy development and is currently in an early, incomplete state.
    Features and documentation are lacking.
    Appearance, functionality and file formats may change at any time.
    Malfunctions may occur which kill your pets.

    Regardless, the application is still functional and provides useful features.
    It is released with the hope it is useful, but comes with no warranty.
    Please submit bug reports, suggestions or feature requests on the `issue tracker <https://gitlab.com/ptapping/trspectrometer/-/issues>`_.


Installation
------------

The latest release can be downloaded and installed using the Package Installer for Python (pip):

.. code-block:: sh

    pip install --upgrade trspectrometer

On Linux, a launcher icon should be installed in your menus (this feature is not yet implemented on Windows or MacOS).
On all operating systems, the application can be launched from the command line:

.. code-block:: sh

    trspectrometer

Further details can be found in the `Getting Started <https://trspectrometer.readthedocs.io/en/latest/gettingstarted.html>`_ section of the documentation.

Support
-------

Documentation can be read online at `Read the Docs <https://trspectrometer.readthedocs.io/>`_.

Bug reports, feature requests and suggestions can be submitted to the `issue tracker <https://gitlab.com/ptapping/trspectrometer/-/issues>`_.

License
-------

All original work is free and open source, licensed under the GNU Public License.
See the `LICENSE.txt <https://gitlab.com/ptapping/trspectrometer/-/blob/main/LICENSE.txt>`_ for details.

A version of the pyqtgraph library is bundled with the application, and is under an MIT license.
See `trspectrometer/pyqtgraph/LICENSE.txt <https://gitlab.com/ptapping/trspectrometer/-/blob/main/trspectrometer/pyqtgraph/LICENSE.txt>`_ for details.



