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.14.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distributions

stcal-1.14.1-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.14.1-cp313-cp313-macosx_11_0_arm64.whl (949.8 kB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

stcal-1.14.1-cp313-cp313-macosx_10_13_x86_64.whl (970.8 kB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

stcal-1.14.1-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.14.1-cp312-cp312-macosx_11_0_arm64.whl (952.5 kB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

stcal-1.14.1-cp312-cp312-macosx_10_13_x86_64.whl (974.2 kB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

stcal-1.14.1-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.14.1-cp311-cp311-macosx_11_0_arm64.whl (953.0 kB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

stcal-1.14.1-cp311-cp311-macosx_10_9_x86_64.whl (972.0 kB view details)

Uploaded CPython 3.11macOS 10.9+ x86-64

File details

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

File metadata

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

File hashes

Hashes for stcal-1.14.1.tar.gz
Algorithm Hash digest
SHA256 12dff3b0c906ce40edc4d7e6a7d828bb0b59cba02a507c7872a638b2a80d7cf8
MD5 3d25c0b780845fc2a4cbeabdac71f1a7
BLAKE2b-256 8637bd380b8865016441b73023ecaa733602f00da5884757d7c775cab0de3d98

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 94caaac4880cca8fa6bc3f8f42eb5e0aa9fb4b3f094828135832880377b2d35e
MD5 97ab4d80d3656ee58906c2f0c92e9bda
BLAKE2b-256 ebbdd70d6ab0ad6f96f0bb20106cc18a464085b8db5c89c29402870513a71801

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 60e1d433bbae8aaa5efc609b4826ad9f0bbae4a95476d233210dbc0b767d2224
MD5 44710413e4de8ea30c06ebb1e28a249b
BLAKE2b-256 ef30d99b21ccf9a0bb1a02bd3f8d4f61b687d978f594ce4d7b1036913c8c4c87

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 b26298a787d967bf9e94eb1917c0fa0740bd9e650149baf51e8156ca8b8bd397
MD5 9dd483cc39a7d95968d4f7949d8de566
BLAKE2b-256 09f8daa7425fd72fc7d09dbc1f69b5126e4c4010929b49b6a1d494698fd14098

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 6aed2dd26fe54ced0ea1b981bf4e3e41f9193068003e3f50d8301970e799a62b
MD5 ab626d5c8d6c2895654cfc604f068b7e
BLAKE2b-256 b52037b8819e7914dc90bc09d72f9744ec7dfc000132d53740919f5909222e08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3221ca535420c5c74eac48aefe7f8f397676f2bb81577971223c27d10d8e4c02
MD5 03da4ccc0c9e30df49b15ac6e4aacaaf
BLAKE2b-256 9ce4ecf76330e95b68fe7d3ce675ee42350b6b99ca227b312ecb80adabddcf67

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 2e06b362d9964f585d933787df50cf37c9d96babd904cf147bf2720a57ee4b95
MD5 34f883c7529daccaf4b23aded66b29d1
BLAKE2b-256 b491adae6d1cc077b9a2a20edcf90a455c3ab358ae747100d9082792d2a11cf4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 99f9e5545204dd5d3f89f4be30ed87f51bd0680181ca1bc758a038557ab3bada
MD5 430a00501394aa2d8ca91b20cdcb19a9
BLAKE2b-256 da45ee2ccc1c2f7ae83300045ddb3ca592a2942710b3e714d2c252003e8bf8d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 935332244977e83ab4837dcca0b3e694d3101b259611ee042f2c724976ed7c67
MD5 f3c3a9262c1148b1390096b6123b65dd
BLAKE2b-256 8a7df26f43ffd464d4590ed5d70d0236b55d55463388093064e885849616c64d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.14.1-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 9c9590b55a6c510eabaaf3f1d4c301685651699cb81352d77723a50d0254b6d3
MD5 3de3d700bf886348aaca22a5112418cd
BLAKE2b-256 ac445a4b48d4e2e647c763b30d19706e3acf6820e7cfc75af2e2b6cf043c3cac

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