Metadata-Version: 2.3
Name: rimsschemedrawer
Version: 3.0.0.dev4
Summary: Drawing of RIMS schemes in python and/or with a Python GUI.
Project-URL: Homepage, https://github.com/RIMS-Code/RIMSSchemeDrawer
Project-URL: Documentation, https://github.com/RIMS-Code/RIMSSchemeDrawer
Project-URL: Repository, https://github.com/RIMS-Code/RIMSSchemeDrawer.git
Project-URL: Issues, https://github.com/RIMS-Code/RIMSSchemeDrawer/issues
Author-email: Reto Trappitsch <reto@galactic-forensics.space>
License: MIT
License-File: LICENSE
Requires-Python: >=3.8
Requires-Dist: matplotlib>=3.7.4
Requires-Dist: numpy>=1.24.4
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5.12; extra == 'docs'
Requires-Dist: mkdocs>=1.5.3; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.24.1; extra == 'docs'
Provides-Extra: gui
Requires-Dist: pyqt6>=6.6.1; extra == 'gui'
Requires-Dist: qtpy>=2.4.1; extra == 'gui'
Description-Content-Type: text/markdown

# RIMSSchemeDrawer

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/mitsuhiko/rye/main/artwork/badge.json)](https://rye-up.com)
[![PyPI](https://img.shields.io/pypi/v/rimsschemedrawer)](https://pypi.org/project/rimsschemedrawer/)
[![Documentation Status](https://readthedocs.org/projects/rimsschemedrawer/badge/?version=latest)](https://rimsschemedrawer.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/RIMS-Code/RIMSSchemeDrawer/graph/badge.svg?token=TUUIKGLGGD)](https://codecov.io/gh/RIMS-Code/RIMSSchemeDrawer)
[![tests](https://github.com/RIMS-Code/RIMSSchemeDrawer/actions/workflows/package_testing.yml/badge.svg)](https://github.com/RIMS-Code/RIMSSchemeDrawer/actions/workflows/package_testing.yml)

## Welcome!

As the name implies,
the `RIMSSchemeDrawer` is a tool to draw resonance ionization schemes.
The goal of this package is to create a publication-ready figure.

The easiest way to use the software is via a graphical user interface (GUI).
However, the software can also be used as a library.

For details on installation, usage, etc.,
please see the [documentation](https://rimsschemedrawer.readthedocs.io/en/latest/).

## Issues/Enhancements

If you run into any problems with the software
or have ideas for enhancements,
please raise an issue [here on GitHub](https://github.com/RIMS-Code/RIMSSchemeDrawer/issues).

## License

This software is licensed under the [MIT license](https://github.com/RIMS-Code/RIMSSchemeDrawer/blob/main/LICENSE).
