Skip to content

A Qt6 GUI interface to do spectroscopic redshift measuremetns

License

Notifications You must be signed in to change notification settings

mauritiusdadd/redmost

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DOI DOCS Coverage Status Testing PyQt6 Testing PySide6

REDMOST

REDshift Measurements Of SpecTra is a Qt6 Graphical User Interface (GUI) to do redshift measurements on 1D spectra.

Redmost main window

If redrock is correctly installed, it cat be used as a backend to measure the redshift.

Installation

This is a python program based on Qt6 and supports both PyQt6 and PySide6 backends. It also support PyQt5 backend but it is not fully tested and may not work as expected. Since it is a good practice to not mess up the system-wide python environment, you should install this program in a virtual environment. If you don't have a virtual environment yet, you can create one with the command

python -m venv env_name

For example, to create a virtual environment called "astro", you can use the command

python -m venv astro

and you can activate it with

. astro/bin/activate

From this GIT repository

To install the bleeding edge version, first clone this repository

git clone https://github.com/mauritiusdadd/redmost.git
cd redmost

and then run pip specifying which Qt backend you want to use:

  • for PyQt6: pip install .[pyqt6]
  • for PySide6: pip install .[pyside6]
  • for PySide5: pip install .[pyqt5] (only for compatibility, may not work as expected)

From PyPi

just use pip, like for any other packages. Keep in mind that packaged releases may be older than the git version and could lack of some newly implemented functionalities.

  • for PyQt6: pip install redmost[pyqt6]
  • for PySide6: pip install redmost[pyside6]
  • for PyQt5: pip install redmost[pyqt5]

After the installation, to update redmost to the most recent release, use

pip install redmost --upgrade

Install third party backends

Redmost can use modular backends to measure the redshift, although only redrock is currently supported. Please check and follow the installation instructions of the single packages!

Run

To run the program just run the command redmost in a terminal. If you have both PyQt and Pyside installed, you can force the program to use a specific backend using the environment variable QT_API, for example:

QT_API="pyside6" redmost

Docs and tutorials

The full documentation is available at: https://redmost.readthedocs.io/en/latest

Acknowledgements

If you use this software for your work, please consider to include a citation to 10.5281/zenodo.10817884.

Also remember to acknowledge:

This program uses icons derived from the following themes:

About

A Qt6 GUI interface to do spectroscopic redshift measuremetns

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages