| Name | redmost JSON |
| Version |
0.4.7
JSON |
| download |
| home_page | None |
| Summary | Display spectra and estimate their redshifts. |
| upload_time | 2024-05-09 07:25:59 |
| maintainer | Maurizio D'Addona |
| docs_url | None |
| author | Maurizio D'Addona |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2023-2024, Maurizio D'Addona <mauritiusdadd@gmail.com> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
spectroscopy
fits
astronomy
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://doi.org/10.5281/zenodo.10817885)
[](https://redmost.readthedocs.io/en/latest/) [](https://coveralls.io/github/mauritiusdadd/redmost?branch=main) [](https://github.com/mauritiusdadd/redmost/actions/workflows/test_linux_pyqt6.yml) [](https://github.com/mauritiusdadd/redmost/actions/workflows/test_linux_pyside6.yml)
# REDMOST
<b>RED</b>shift <b>M</b>easurements <b>O</b>f <b>S</b>pec<b>T</b>ra is a Qt6 Graphical User Interface (GUI) to do redshift measurements on 1D spectra.
If [redrock][1] 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!
- redrock backend: [https://github.com/desihub/redrock][1]
# 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][4].
Also remember to acknowledge:
- astropy: [https://www.astropy.org/acknowledging.html][3]
- specutils: [https://github.com/astropy/specutils/blob/main/specutils/CITATION][2]
- redrock: [https://github.com/desihub/redrock][1] (if you use the redrock backend)
This program uses icons derived from the following themes:
- feather: [https://github.com/feathericons/feather][5]
[1]: https://github.com/desihub/redrock
[2]: https://www.astropy.org/acknowledging.html
[3]: https://github.com/astropy/specutils/blob/main/specutils/CITATION
[4]: https://zenodo.org/records/10818017
[5]: https://github.com/feathericons/feather
Raw data
{
"_id": null,
"home_page": null,
"name": "redmost",
"maintainer": "Maurizio D'Addona",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "mauritiusdadd@gmail.com",
"keywords": "spectroscopy, FITS, astronomy",
"author": "Maurizio D'Addona",
"author_email": "mauritiusdadd@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/76/33/9fda4ade24ca676a016e9572e8e174189221d56ed538fadffc4f2ba6bc30/redmost-0.4.7.tar.gz",
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.10817885)\n[](https://redmost.readthedocs.io/en/latest/) [](https://coveralls.io/github/mauritiusdadd/redmost?branch=main) [](https://github.com/mauritiusdadd/redmost/actions/workflows/test_linux_pyqt6.yml) [](https://github.com/mauritiusdadd/redmost/actions/workflows/test_linux_pyside6.yml)\n# REDMOST \n\n<b>RED</b>shift <b>M</b>easurements <b>O</b>f <b>S</b>pec<b>T</b>ra is a Qt6 Graphical User Interface (GUI) to do redshift measurements on 1D spectra.\n\n\n\nIf [redrock][1] is correctly installed, it cat be used as a backend to measure the redshift.\n\n# Installation\n\nThis 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.\nSince 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\n\n```python -m venv env_name```\n\nFor example, to create a virtual environment called \"astro\", you can use the command\n\n```python -m venv astro```\n\nand you can activate it with\n\n```. astro/bin/activate```\n\n\n## From this GIT repository\nTo install the bleeding edge version, first clone this repository\n \n```\ngit clone https://github.com/mauritiusdadd/redmost.git\ncd redmost\n```\n\nand then run pip specifying which Qt backend you want to use:\n\n- for PyQt6: ```pip install .[pyqt6]```\n- for PySide6: ```pip install .[pyside6]```\n- for PySide5: ```pip install .[pyqt5]``` (only for compatibility, may not work as expected)\n\n## From PyPi\n\njust 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.\n\n- for PyQt6: ```pip install redmost[pyqt6]```\n- for PySide6: ```pip install redmost[pyside6]```\n- for PyQt5: ```pip install redmost[pyqt5]```\n\nAfter the installation, to update redmost to the most recent release, use\n\n```pip install redmost --upgrade```\n\n## Install third party backends\n\nRedmost 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!\n\n- redrock backend: [https://github.com/desihub/redrock][1]\n\n# Run\n\nTo 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:\n\n```QT_API=\"pyside6\" redmost```\n\n# Docs and tutorials\n\nThe full documentation is available at: https://redmost.readthedocs.io/en/latest\n\n# Acknowledgements\n\nIf you use this software for your work, please consider to include a citation to [10.5281/zenodo.10817884][4].\n\nAlso remember to acknowledge:\n\n- astropy: [https://www.astropy.org/acknowledging.html][3]\n- specutils: [https://github.com/astropy/specutils/blob/main/specutils/CITATION][2]\n- redrock: [https://github.com/desihub/redrock][1] (if you use the redrock backend)\n\nThis program uses icons derived from the following themes:\n\n- feather: [https://github.com/feathericons/feather][5]\n\n[1]: https://github.com/desihub/redrock\n[2]: https://www.astropy.org/acknowledging.html\n[3]: https://github.com/astropy/specutils/blob/main/specutils/CITATION\n[4]: https://zenodo.org/records/10818017\n[5]: https://github.com/feathericons/feather\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023-2024, Maurizio D'Addona <mauritiusdadd@gmail.com> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Display spectra and estimate their redshifts.",
"version": "0.4.7",
"project_urls": {
"repository": "https://github.com/mauritiusdadd/redmost"
},
"split_keywords": [
"spectroscopy",
" fits",
" astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9c7dc71d112d1400e427f46d30be3c142c09baa273f99823b0954e7b6259b791",
"md5": "c653973157df8b698199a1d69a01f949",
"sha256": "beaba0398f61a6080921d23accc84775d03a800c629c4e4d041977c985dd4ccf"
},
"downloads": -1,
"filename": "redmost-0.4.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c653973157df8b698199a1d69a01f949",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 109689,
"upload_time": "2024-05-09T07:25:53",
"upload_time_iso_8601": "2024-05-09T07:25:53.051202Z",
"url": "https://files.pythonhosted.org/packages/9c/7d/c71d112d1400e427f46d30be3c142c09baa273f99823b0954e7b6259b791/redmost-0.4.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76339fda4ade24ca676a016e9572e8e174189221d56ed538fadffc4f2ba6bc30",
"md5": "bde6220faf71bc4654bd6b1d8a15a5dc",
"sha256": "c3bd8ef2b0f752c5245b441b61f328427205284f1d064f653c1a8854ce77f969"
},
"downloads": -1,
"filename": "redmost-0.4.7.tar.gz",
"has_sig": false,
"md5_digest": "bde6220faf71bc4654bd6b1d8a15a5dc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1602756,
"upload_time": "2024-05-09T07:25:59",
"upload_time_iso_8601": "2024-05-09T07:25:59.820670Z",
"url": "https://files.pythonhosted.org/packages/76/33/9fda4ade24ca676a016e9572e8e174189221d56ed538fadffc4f2ba6bc30/redmost-0.4.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 07:25:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mauritiusdadd",
"github_project": "redmost",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "redmost"
}
