specex


Namespecex JSON
Version 0.7.11 PyPI version JSON
download
home_pageNone
SummaryExtract spectra from fits cubes
upload_time2024-07-22 12:18:33
maintainerMaurizio D'Addona
docs_urlNone
authorMaurizio D'Addona
requires_python>=3.7
licenseBSD 3-Clause License Copyright (c) 2022-2023, Maurizio D'Addona <mauritiusdadd@gmail.com> All rights reserved. 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 spectra spectrum spectral cubes
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7808292.svg)](https://doi.org/10.5281/zenodo.7808292) [![Documentation Status](https://readthedocs.org/projects/python-specex/badge/?version=latest)](https://python-specex.readthedocs.io/en/latest/?badge=latest) [![Build Status](https://github.com/mauritiusdadd/python-specex/actions/workflows/build-and-check.yml/badge.svg)](https://github.com/mauritiusdadd/python-specex/actions/workflows/build-and-check.yml) [![Coverage Status](https://coveralls.io/repos/github/mauritiusdadd/python-specex/badge.svg?branch=main)](https://coveralls.io/github/mauritiusdadd/python-specex?branch=main)
# python-specex

Extract spectra from fits cubes

# SETUP

To install the latest stable version of specex, just use pip:

    $ pip install specex

Some functionalities are enabled only if some optional packages are installed, these packages can be installed by pip when installing Specex by specifing the desired configuration, for example

    $ pip install specex[animation]

will install the packages required to use the command specex-cube-anim, while with the command

    $ pip install specex[animation,regions,redrock]

also the packages to use rrspecex and to enable region file handling will be installed. To install all the optional dependencies use

    $ pip install specex[all]

To install the bleeding edge version, clone the github repository then use pip:

    $ git clone 'https://github.com/mauritiusdadd/python-specex.git'
    $ cd python-specex
    $ pip install .

If you want to use the rrspecex script and the correspondig module, make sure to install also redrock. If you don't already have a system wide installation of redrock, a simple script is provided that creates a python venv and downloads and installs the required packages, in this case the commands to install specex are the following:

    $ chmod +x redrock_venv_setup.sh
    $ ./redrock_venv_setup.sh
    $ . ./redrock_venv/bin/activate
    $ pip install .[redrock]

# DOCUMENTATION

To build the documentation, install the requirements and run sphinx:

    $ pip install -r docs/requirements.txt
    $ sphinx-build -b html docs/ docs/_build/html

The full documentation is also available here: [https://python-specex.readthedocs.io/en/latest/index.html]

# ACKNOWLEDGMENTS

If you used this software for your research, please consider to cite the following article

https://doi.org/10.1051/0004-6361/202349060

```
@ARTICLE{DAddona2024,
  title     = "The powerful lens galaxy cluster {PLCK} G287.0+32.9
               ({$\vartheta$E} $\sim 43$ ′′)",
  author    = "D'Addona, M and Mercurio, A and Rosati, P and Grillo, C and
               Caminha, G and Acebron, A and Angora, G and Bergamini, P and
               Bozza, V and Granata, G and Annunziatella, M and Gargiulo, A and
               Gobat, R and Tozzi, P and Girardi, M and Lombardi, M and
               Meneghetti, M and Schipani, P and Tortorelli, L and Vanzella, E",
  journal   = "Astron. Astrophys.",
  publisher = "EDP Sciences",
  month     =  feb,
  year      =  2024,
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "specex",
    "maintainer": "Maurizio D'Addona",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "mauritiusdadd@gmail.com",
    "keywords": "spectroscopy, spectra, spectrum, spectral cubes",
    "author": "Maurizio D'Addona",
    "author_email": "mauritiusdadd@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/53/c6/eb7d0dfd7e81796985c919e21cd9112af3ffd71c5757559768e48e8a8a6e/specex-0.7.11.tar.gz",
    "platform": null,
    "description": "[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7808292.svg)](https://doi.org/10.5281/zenodo.7808292) [![Documentation Status](https://readthedocs.org/projects/python-specex/badge/?version=latest)](https://python-specex.readthedocs.io/en/latest/?badge=latest) [![Build Status](https://github.com/mauritiusdadd/python-specex/actions/workflows/build-and-check.yml/badge.svg)](https://github.com/mauritiusdadd/python-specex/actions/workflows/build-and-check.yml) [![Coverage Status](https://coveralls.io/repos/github/mauritiusdadd/python-specex/badge.svg?branch=main)](https://coveralls.io/github/mauritiusdadd/python-specex?branch=main)\n# python-specex\n\nExtract spectra from fits cubes\n\n# SETUP\n\nTo install the latest stable version of specex, just use pip:\n\n    $ pip install specex\n\nSome functionalities are enabled only if some optional packages are installed, these packages can be installed by pip when installing Specex by specifing the desired configuration, for example\n\n    $ pip install specex[animation]\n\nwill install the packages required to use the command specex-cube-anim, while with the command\n\n    $ pip install specex[animation,regions,redrock]\n\nalso the packages to use rrspecex and to enable region file handling will be installed. To install all the optional dependencies use\n\n    $ pip install specex[all]\n\nTo install the bleeding edge version, clone the github repository then use pip:\n\n    $ git clone 'https://github.com/mauritiusdadd/python-specex.git'\n    $ cd python-specex\n    $ pip install .\n\nIf you want to use the rrspecex script and the correspondig module, make sure to install also redrock. If you don't already have a system wide installation of redrock, a simple script is provided that creates a python venv and downloads and installs the required packages, in this case the commands to install specex are the following:\n\n    $ chmod +x redrock_venv_setup.sh\n    $ ./redrock_venv_setup.sh\n    $ . ./redrock_venv/bin/activate\n    $ pip install .[redrock]\n\n# DOCUMENTATION\n\nTo build the documentation, install the requirements and run sphinx:\n\n    $ pip install -r docs/requirements.txt\n    $ sphinx-build -b html docs/ docs/_build/html\n\nThe full documentation is also available here: [https://python-specex.readthedocs.io/en/latest/index.html]\n\n# ACKNOWLEDGMENTS\n\nIf you used this software for your research, please consider to cite the following article\n\nhttps://doi.org/10.1051/0004-6361/202349060\n\n```\n@ARTICLE{DAddona2024,\n  title     = \"The powerful lens galaxy cluster {PLCK} G287.0+32.9\n               ({$\\vartheta$E} $\\sim 43$ \u2032\u2032)\",\n  author    = \"D'Addona, M and Mercurio, A and Rosati, P and Grillo, C and\n               Caminha, G and Acebron, A and Angora, G and Bergamini, P and\n               Bozza, V and Granata, G and Annunziatella, M and Gargiulo, A and\n               Gobat, R and Tozzi, P and Girardi, M and Lombardi, M and\n               Meneghetti, M and Schipani, P and Tortorelli, L and Vanzella, E\",\n  journal   = \"Astron. Astrophys.\",\n  publisher = \"EDP Sciences\",\n  month     =  feb,\n  year      =  2024,\n}\n```\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License  Copyright (c) 2022-2023, Maurizio D'Addona <mauritiusdadd@gmail.com> All rights reserved.  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": "Extract spectra from fits cubes",
    "version": "0.7.11",
    "project_urls": {
        "documentation": "https://python-specex.readthedocs.io/en/latest",
        "repository": "https://github.com/mauritiusdadd/python-specex"
    },
    "split_keywords": [
        "spectroscopy",
        " spectra",
        " spectrum",
        " spectral cubes"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f0510ffad62c42054a480c8f549605d22238bc044323f5ba04d1c4746926a4f1",
                "md5": "6606907887dd13c54ad3fb1f08f421dd",
                "sha256": "47b1704abee8202e8e1b6fce3bcd76e229978fa1a5082ce78934c5955c65e6ff"
            },
            "downloads": -1,
            "filename": "specex-0.7.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6606907887dd13c54ad3fb1f08f421dd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 79037,
            "upload_time": "2024-07-22T12:18:27",
            "upload_time_iso_8601": "2024-07-22T12:18:27.098279Z",
            "url": "https://files.pythonhosted.org/packages/f0/51/0ffad62c42054a480c8f549605d22238bc044323f5ba04d1c4746926a4f1/specex-0.7.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "53c6eb7d0dfd7e81796985c919e21cd9112af3ffd71c5757559768e48e8a8a6e",
                "md5": "bef4cb725bb55ad6e4570782d837b4e4",
                "sha256": "da704aaef555e39b7e4369a962d05a7ea49c8245686ff4ca1ed632de81610bf7"
            },
            "downloads": -1,
            "filename": "specex-0.7.11.tar.gz",
            "has_sig": false,
            "md5_digest": "bef4cb725bb55ad6e4570782d837b4e4",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2357674,
            "upload_time": "2024-07-22T12:18:33",
            "upload_time_iso_8601": "2024-07-22T12:18:33.982298Z",
            "url": "https://files.pythonhosted.org/packages/53/c6/eb7d0dfd7e81796985c919e21cd9112af3ffd71c5757559768e48e8a8a6e/specex-0.7.11.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-22 12:18:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mauritiusdadd",
    "github_project": "python-specex",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "specex"
}
        
Elapsed time: 4.30366s