TiRiFiG 2.0.2

Development Status :: 4 - Beta

TiRiFiG: A graphical 3D kinematic modelling tool

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.

Requirements

The code requires full installation of:

PyQt6 (available through pip)
TiRiFiC

Installation

Installation from source, working directory where source is checked out

$ pip install .

This package is available on PYPI, allowing

$ 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.