Metadata-Version: 2.4
Name: TiRiFiG
Version: 2.0.2
Summary: Development Status :: 4 - Beta
Project-URL: Homepage, https://github.com/PeterKamphuis/TiRiFiG
Author-email: "S. Twum, P. Kamphuis" <peterkamphuisastronomy@gmail.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.8
Requires-Dist: pyfat-astro
Requires-Dist: pyqt6
Requires-Dist: trm-errors>=0.1.1
Description-Content-Type: text/x-rst

================================================
TiRiFiG: A graphical 3D kinematic modelling tool
================================================

|PyPI Version|


TiRiFiC_ is a 3D kinematic modelling tool used to model resolved spectroscopic
observations of rotating discs in terms of the tilted-ring model with varying complexity.
The front-end (TiRiFiG, Tilted-Ring-Fitting-GUI), part of the toolkit, is an aid to
enable the user to perform the modelling process interactively.

.. |PyPI Version| image:: https://img.shields.io/badge/pypi-beta-orange.svg
                  :target: https://pypi.org/project/TiRiFiG/
                  :alt:

.. _PEP8: https://www.python.org/dev/peps/pep-0008/
.. _source: https://github.com/gigjozsa/TiRiFiG
.. _license: https://github.com/gigjozsa/TiRiFiG/blob/master/LICENSE
.. _TiRiFiC: http://gigjozsa.github.io/tirific/
.. _website: https://www.riverbankcomputing.com/software/pyqt/download

============
Requirements
============

The code requires full installation of:

.. code-block:: bash
  
    PyQt6 (available through pip)
    TiRiFiC

============
Installation
============

Installation from source_, working directory where source is checked out

.. code-block:: bash
  
    $ pip install .

This package is available on *PYPI*, allowing

.. code-block:: bash
  
    $ pip install TiRiFiG (This is for now an older version)

Download and installation notes for TiRiFiC_ is on its website. Once installed, add TiRiFiG to your PYTHONPATH using 
``export PATH='path_to_installation_directory:$PATH'``.

=====
Usage
=====

Start TiRiFiG, from the terminal.

With the GUI running, the next steps are:

- Adjust data points for the parameter(s) using the mouse.
- Possibly fit a polynomial to the dat points.
- Start TiRiFiC from run menu to perform fitting.

=======
License
=======

This project is licensed under the MIT License - see license_ for details.

==========
Contribute
==========

Contributions are always welcome! Please ensure that you adhere to PEP8_ coding style guide.
