Skip to main content

STScI tools and algorithms used in calibration pipelines

Project description

STCAL

Documentation Status

CI

codecov

STScI Calibration algorithms and tools.

STScI Logo

[!IMPORTANT] STCAL requires Python 3.10 or above and a C compiler for dependencies.

[!IMPORTANT] Linux and MacOS platforms are tested and supported. Windows is not currently supported.**

[!WARNING] Installation on MacOS Mojave 10.14 will fail due to lack of a stable build for dependency opencv-python.

STCAL is intended to be used as a support package for calibration pipeline software, such as the JWST and Roman calibration pipelines. STCAL is a separate package because it is also intended to be software that can be reused by multiple calibration pipelines. Even though it is intended to be a support package for calibration pipelines, it can be installed and used as a stand alone package. This could make usage unwieldy as it is easier to use STCAL through calibration software. The main use case for stand alone installation is for development purposes, such as bug fixes and feature additions. When installing calibration pipelines that depend on STCAL this package automatically gets installed as a dependency.

Installation

The easiest way to install the latest stcal release into a fresh virtualenv or conda environment is

pip install stcal

Detailed Installation

The stcal package can be installed into a virtualenv or conda environment via pip. We recommend that for each installation you start by creating a fresh environment that only has Python installed and then install the stcal package and its dependencies into that bare environment. If using conda environments, first make sure you have a recent version of Anaconda or Miniconda installed. If desired, you can create multiple environments to allow for switching between different versions of the stcal package (e.g. a released version versus the current development version).

In all cases, the installation is generally a 3-step process:

  • Create a conda environment
  • Activate that environment
  • Install the desired version of the stcal package into that environment

Details are given below on how to do this for different types of installations, including tagged releases and development versions. Remember that all conda operations must be done from within a bash/zsh shell.

Installing latest releases

You can install the latest released version via pip. From a bash/zsh shell:

conda create -n <env_name> python
conda activate <env_name>
pip install stcal

You can also install a specific version, for example stcal 1.3.2:

conda create -n <env_name> python
conda activate <env_name>
pip install stcal==1.3.2

Installing the development version from Github

You can install the latest development version (not as well tested) from the Github master branch:

conda create -n <env_name> python
conda activate <env_name>
pip install git+https://github.com/spacetelescope/stcal

Installing for Developers

If you want to be able to work on and test the source code with the stcal package, the high-level procedure to do this is to first create a conda environment using the same procedures outlined above, but then install your personal copy of the code overtop of the original code in that environment. Again, this should be done in a separate conda environment from any existing environments that you may have already installed with released versions of the stcal package.

As usual, the first two steps are to create and activate an environment:

conda create -n <env_name> python
conda activate <env_name>

To install your own copy of the code into that environment, you first need to fork and clone the stcal repo:

cd <where you want to put the repo>
git clone https://github.com/spacetelescope/stcal
cd stcal

Note: python setup.py install and python setup.py develop commands do not work.

Install from your local checked-out copy as an "editable" install:

pip install -e .

If you want to run the unit or regression tests and/or build the docs, you can make sure those dependencies are installed too:

pip install -e ".[test]"
pip install -e ".[docs]"
pip install -e ".[test,docs]"

Need other useful packages in your development environment?

pip install ipython jupyter matplotlib pylint ipdb

Contributions and Feedback

We welcome contributions and feedback on the project. Please follow the contributing guidelines to submit an issue or a pull request.

We strive to provide a welcoming community to all of our users by abiding with the Code of Conduct.

If you have questions or concerns regarding the software, please open an issue at https://github.com/spacetelescope/stcal/issues.

Unit Tests

Unit tests can be run via pytest. Within the top level of your local stcal repo checkout:

pip install -e ".[test]"
pytest

Need to parallelize your test runs over all available cores?

pip install pytest-xdist
pytest -n auto

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

stcal-1.13.0.tar.gz (1.2 MB view details)

Uploaded Source

Built Distributions

stcal-1.13.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.5 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.17+ x86-64

stcal-1.13.0-cp313-cp313-macosx_11_0_arm64.whl (946.2 kB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

stcal-1.13.0-cp313-cp313-macosx_10_13_x86_64.whl (967.2 kB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

stcal-1.13.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.17+ x86-64

stcal-1.13.0-cp312-cp312-macosx_11_0_arm64.whl (948.8 kB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

stcal-1.13.0-cp312-cp312-macosx_10_13_x86_64.whl (970.0 kB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

stcal-1.13.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.17+ x86-64

stcal-1.13.0-cp311-cp311-macosx_11_0_arm64.whl (949.5 kB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

stcal-1.13.0-cp311-cp311-macosx_10_9_x86_64.whl (968.5 kB view details)

Uploaded CPython 3.11macOS 10.9+ x86-64

File details

Details for the file stcal-1.13.0.tar.gz.

File metadata

  • Download URL: stcal-1.13.0.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for stcal-1.13.0.tar.gz
Algorithm Hash digest
SHA256 4f5e7dc4d5b067262b650d8c976dc9161fae7280ad5150db70bc2976e1e9ae03
MD5 3e7fea254abc5477a3225cdca1ef17d7
BLAKE2b-256 3ba52722981629bbd242ffb2bd0ff4478d110d83edfa71d9bf3cde7272920044

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 4739f22ed2c253caa062ae07a6dcf617cb4452b35367af79ce542a9667884b58
MD5 a3f3fb8c3927534037e70ea8dfb6e866
BLAKE2b-256 ff496632776243b655ca774fb6e79c63105daab222ce95f26dbb5a57f04c24f5

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b0532afe012c732ec58e6d70d1aa6a8bdd13230d053218fa885684a3a18829de
MD5 a7f15e81756f9c5fba117b3cc73c2f8a
BLAKE2b-256 eca9b7f58798dc0a46d329fda23503b6bc9be7023d8f9cb6dd1601150d111e69

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp313-cp313-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 d0bd029a180622aa87167b8edf030b282c0ccb9ada05280a4b0eca67c8edc564
MD5 5e4287cccd10e3b70c287f2a2a8dd971
BLAKE2b-256 8ac07c0e2064e91fcefa4affc09037be20f38935ed5130306c9aa279e71827c4

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a087349e10b806d174b3ae82e09e3165a596895ce50658b981de5337a78a0170
MD5 404ffbc06dc776f97b5c2e732662b7a9
BLAKE2b-256 81907cc978ec0ad7b3c6c48d8787306fcb6678012e230487fb16431afe482196

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 edadb8f6a349e161fba0108035c05e1215d522593bec799ce6132d69782c3c0f
MD5 b240d8e90bbf04b211af7a5569681b94
BLAKE2b-256 423fb09ec99a58f6371862f9e3a0ae396f32cd73f31860ef6c4aef34a918a68c

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 174ef70dabdfb34c621882555e06c5ca083b67e06824ccbfde60d3a42ff14d73
MD5 165ed7a39be4cdf131e7cb750a8db285
BLAKE2b-256 d8f1d75036b1ef2216a53837c31d442bba2b7c52bdebcc69a110d816b32d8298

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 76faf704d2de7e2f4f9ea3ac5c3689d647f30daad220d746e24a8b298d0f1ab5
MD5 49c0f43164fa9fb57253323eaa54f387
BLAKE2b-256 7fb65f86910003fc528f7163a7172cad5a6e498a50ea64c83c127527a367f8e1

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f5c6c148179d1f2fb4c534c1492c2bbc996bde74ee34203c98594139502f3339
MD5 6a434941f8fc0ea115388017411fb7de
BLAKE2b-256 e5b68901fd89364942f948781e68ba072e68f4e6e47b6639244a83b0b6ce8116

See more details on using hashes here.

File details

Details for the file stcal-1.13.0-cp311-cp311-macosx_10_9_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.13.0-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 8f27dcac600a9b2bad6433e8383f7a663ac2147202bd43404d0319afa54533cd
MD5 46ca09ace1e8cceef44b602f2cf062b5
BLAKE2b-256 20609e2cd35db6d36a399895bd150767ee35855cbb50e8e833a409d40dbcdc43

See more details on using hashes here.

Supported by

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