| Name | fits2rgb JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | None |
| Summary | Merge multiple FITS images into a single FITS RGB file. |
| upload_time | 2024-04-03 11:31:12 |
| 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 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 |
imaging
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.7808276)
[](https://github.com/mauritiusdadd/fits2rgb/actions/workflows/test_linux.yml)
[](https://fits2rgb.readthedocs.io/en/latest/?badge=latest)
[](https://coveralls.io/github/mauritiusdadd/fits2rgb)
# fits2rgb
A simple program for making coadded RGB FITS images for visualization.
Full documentation is available at https://fits2rgb.readthedocs.io/en/latest/index.html
# Installation
### Installing a Packaged Release
The simplest way to install fits2rgb is using ``pip`` and, 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
```
source astro/bin/activate
```
Then run
```
pip install fits2rgb
```
After the installation, to update redmost to the most recent release, use
```
pip install fits2rgb --upgrade
```
### Installing from GitHub
If you like to use the bleeding-edge version from this repository, do
```
git clone 'https://github.com/mauritiusdadd/fits2rgb.git'
cd fits2rgb
pip install .
```
After the installation, to upgrade to most recent commit use
```
git pull
pip install . --upgrade
```
Then run ```pytest``` to check everything is ok.
# Usage
To create a default configuration file, use the command
```
fits2rgb -d
```
this will create a file named fits2rgb.json that you can edit to specify how and which files you want to coadd.
Then you can run the program by simply invoking it from the command line.
```
fits2rgb
```
You can also specify which configuration file to use, for example
```
fits2rgb -c fits2rgb.json
```
For more dtails, please refer to the [documentation](https://fits2rgb.readthedocs.io/en/latest/index.html).
Raw data
{
"_id": null,
"home_page": null,
"name": "fits2rgb",
"maintainer": "Maurizio D'Addona",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "mauritiusdadd@gmail.com",
"keywords": "imaging, FITS, astronomy",
"author": "Maurizio D'Addona",
"author_email": "mauritiusdadd@gmail.com",
"download_url": null,
"platform": null,
"description": "[](https://doi.org/10.5281/zenodo.7808276) \n[](https://github.com/mauritiusdadd/fits2rgb/actions/workflows/test_linux.yml)\n[](https://fits2rgb.readthedocs.io/en/latest/?badge=latest)\n[](https://coveralls.io/github/mauritiusdadd/fits2rgb)\n\n# fits2rgb \n\nA simple program for making coadded RGB FITS images for visualization. \n\nFull documentation is available at https://fits2rgb.readthedocs.io/en/latest/index.html\n\n# Installation\n\n### Installing a Packaged Release\n\nThe simplest way to install fits2rgb is using ``pip`` and, 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\n\n```\npython -m venv env_name\n```\n\nFor example, to create a virtual environment called \"astro\", you can use the command\n\n```\npython -m venv astro\n```\n\nand you can activate it with\n\n```\nsource astro/bin/activate\n```\nThen run\n\n```\npip install fits2rgb\n```\n \nAfter the installation, to update redmost to the most recent release, use\n\n```\npip install fits2rgb --upgrade\n```\n \n### Installing from GitHub\n\nIf you like to use the bleeding-edge version from this repository, do\n\n```\ngit clone 'https://github.com/mauritiusdadd/fits2rgb.git'\ncd fits2rgb\npip install .\n```\n\nAfter the installation, to upgrade to most recent commit use\n\n```\ngit pull\npip install . --upgrade\n```\n\nThen run ```pytest``` to check everything is ok.\n\n# Usage\n\nTo create a default configuration file, use the command\n\n```\nfits2rgb -d\n```\n\nthis will create a file named fits2rgb.json that you can edit to specify how and which files you want to coadd.\nThen you can run the program by simply invoking it from the command line. \n\n```\nfits2rgb\n```\n\nYou can also specify which configuration file to use, for example\n\n```\nfits2rgb -c fits2rgb.json\n```\n\nFor more dtails, please refer to the [documentation](https://fits2rgb.readthedocs.io/en/latest/index.html).\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023-2024, Maurizio D'Addona 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": "Merge multiple FITS images into a single FITS RGB file.",
"version": "0.2.1",
"project_urls": {
"repository": "https://github.com/mauritiusdadd/fits2rgb"
},
"split_keywords": [
"imaging",
" fits",
" astronomy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e49d9cd52bef15fbbe398f5f1946f61698b4358d384393c0283e52999e2828d",
"md5": "d605e6beb8ed00093fba462cd08817bf",
"sha256": "c2ee5c4a9567f22c0840a2c95c18aa97cf798da84cd1facba26833fd98cf9733"
},
"downloads": -1,
"filename": "fits2rgb-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d605e6beb8ed00093fba462cd08817bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10796,
"upload_time": "2024-04-03T11:31:12",
"upload_time_iso_8601": "2024-04-03T11:31:12.608180Z",
"url": "https://files.pythonhosted.org/packages/4e/49/d9cd52bef15fbbe398f5f1946f61698b4358d384393c0283e52999e2828d/fits2rgb-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 11:31:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mauritiusdadd",
"github_project": "fits2rgb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fits2rgb"
}
