Metadata-Version: 2.4
Name: nionui
Version: 10.2.3
Summary: Nion UI framework.
Author-email: Nion Software <swift@nion.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/nion-software/nionui
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
Requires-Dist: imageio>=2.19.0
Requires-Dist: nionutils<5.0.0,>=4.14.0
Requires-Dist: numpy<3.0,>=2.0
Dynamic: license-file

Introduction
============
This is a Python UI library that can run with a pyside6 or nionui-tool backend.

Installation
============
Install this library using pip or conda.

.. code-block::

    pip install nionui

Install using PySide6 or nionui-tool backend.

.. code-block::

    pip install nionui-tool

.. code-block::

    pip install pyside6

Usage
=====
This UI library supports an application.

To run the example application, use the following command with the appropriate application identifier. It will launch using either the nionui-tool or pyside6 backend, depending on which is installed. If both are installed, it will use the nionui-tool.

.. code-block::

    python -m nionui <application_identifier>

To run the UI demo app, use the following command (application identifier is 'nionui_examples.ui_demo'):

.. code-block::

    python -m nionui nionui_examples.ui_demo

To run the Canvas demo app, use the following command (application identifier is 'nionui_examples.canvas_demo'):

.. code-block::

    python -m nionui nionui_examples.canvas_demo

To run Nion Swift, use the following command (application identifier is 'nionswift'):

.. code-block::

    python -m nionui nionswift
