Skip to main content

Data reduction tools for IFS data.

Project description

PyKOALA

A multi-instrument tool for reducing Integral Field Spectroscopic Data


PyKOALA is an innovative Python-based library designed to provide a robust and flexible framework for Integral Field Spectroscopy (IFS) data reduction. By addressing the complexities of transforming raw measurements into scientifically valuable spectra, PyKOALA simplifies the data reduction pipeline while remaining instrument-agnostic and user-friendly.


Status

Documentation Status test Coverage Status License Supported versions PyPI


Documentation

PyKOALA documentation can be found here.


Installation

Creating a virtual environment (recommended)

To avoid dependency conflicts, we recommend the use of virtual environments for the installation of PyKOALA. For example, a simple way to setup a python environment is by using the venv module:

python3 -m venv venv_pykoala # common conventions are .venv or venv

To activate the environment, use:

source venv_koala/bin/activate

To stop using the environment:

deactivate

Installing from pypi

Every release of PyKOALA is automatically avaialable through PyPI:

python3 -m pip install pykoala-ifs

You can check this link for a complete list of previous releases.

Installing from the source repository

PyKOALA can be installed by cloning this repository using:

git clone https://github.com/pykoala/pykoala.git

Then users can install all required packages with:

cd path/to/pykoala
python3 -m pip install -r requirements.txt  # Install the dependencies
python3 -m pip install .  # Install pykoala

For more further instructions about the installation and virtual environtment setup, check the quick-start documentation.

Users that would like to contribute to the development of PyKOALA can follow the instructions available here.

Tutorials

We provide a comprehensive set of tutorials and test data in a dedicated repository.

License and Acknowledgements

BSD 3-Clause License

Copyright (c) 2020, pykoala 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pykoala_ifs-0.18.3.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

pykoala_ifs-0.18.3-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file pykoala_ifs-0.18.3.tar.gz.

File metadata

  • Download URL: pykoala_ifs-0.18.3.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pykoala_ifs-0.18.3.tar.gz
Algorithm Hash digest
SHA256 72c18e73b4f77effe8a98e8b736554ef31678ad3f93d390651bd22c93ccebbce
MD5 1b9b0e78a35a0d92f04756447d063672
BLAKE2b-256 dc796f6fe8dd91cdf5c32bfaf3445da4056f2f7a563d1a199a21a9d3ead7a89c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pykoala_ifs-0.18.3.tar.gz:

Publisher: publish-on-pypi.yml on pykoala/pykoala

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pykoala_ifs-0.18.3-py3-none-any.whl.

File metadata

  • Download URL: pykoala_ifs-0.18.3-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pykoala_ifs-0.18.3-py3-none-any.whl
Algorithm Hash digest
SHA256 55e25db04eef0fbc756d48313a443b1c75cef9d00d6a113efdf2d33e1d9108df
MD5 d44975034045b50371771b3f8a43d6a5
BLAKE2b-256 406a2f86435c3d19a58cbba013326742c434bd501632f56874a65d44192ff59b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pykoala_ifs-0.18.3-py3-none-any.whl:

Publisher: publish-on-pypi.yml on pykoala/pykoala

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page