STCAL

Documentation Status CI codecov

STScI Calibration algorithms and tools.

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

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 links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

Owner

PyPI data
Data sourced directly from PyPI's database.

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for dencheva from gravatar.com dencheva Avatar for stscieisenhamer from gravatar.com stscieisenhamer

Credits

Author: STScI

Requires

Python >=3.11

Provides Extra

docs test

Classifiers

Report project as malware

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.20.0.tar.gz (858.5 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

stcal-1.20.0-cp314-cp314-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

stcal-1.20.0-cp314-cp314-macosx_11_0_arm64.whl (1.0 MB view details)

Uploaded CPython 3.14macOS 11.0+ ARM64

stcal-1.20.0-cp314-cp314-macosx_10_15_x86_64.whl (1.0 MB view details)

Uploaded CPython 3.14macOS 10.15+ x86-64

stcal-1.20.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

stcal-1.20.0-cp313-cp313-macosx_11_0_arm64.whl (994.5 kB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

stcal-1.20.0-cp313-cp313-macosx_10_13_x86_64.whl (997.3 kB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

stcal-1.20.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

stcal-1.20.0-cp312-cp312-macosx_11_0_arm64.whl (996.6 kB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

stcal-1.20.0-cp312-cp312-macosx_10_13_x86_64.whl (999.5 kB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

stcal-1.20.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.24+ x86-64manylinux: glibc 2.28+ x86-64

stcal-1.20.0-cp311-cp311-macosx_11_0_arm64.whl (992.5 kB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

stcal-1.20.0-cp311-cp311-macosx_10_9_x86_64.whl (993.8 kB view details)

Uploaded CPython 3.11macOS 10.9+ x86-64

File details

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

File metadata

  • Download URL: stcal-1.20.0.tar.gz
  • Upload date:
  • Size: 858.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for stcal-1.20.0.tar.gz
Algorithm Hash digest
SHA256 f96ef45b0bf0ba672c9291b2b2279bc37d55431d9345454ff624821022fb23ac
MD5 9d3421eb29ce2ee1b2986a25828f5128
BLAKE2b-256 8c0ad480b5e6345f2fda274bc000e4b73239838c11460a056ac3b62fe6303a36

See more details on using hashes here.

File details

Details for the file stcal-1.20.0-cp314-cp314-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.20.0-cp314-cp314-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e6b1e760f57638722fe5f7b1d035d1a45c80429922f1df0233a9c4419d118a73
MD5 467a4e3521fda386ff08e167954cddaa
BLAKE2b-256 e2bf351ced4c9ab38d8ec14fc7f1f7e053c6a4aacad6253d06322fd31c65389d

See more details on using hashes here.

File details

Details for the file stcal-1.20.0-cp314-cp314-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for stcal-1.20.0-cp314-cp314-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 59d693429badd327b8f0d5c9227af1325f03e57cee493a4a3682da70a9ba6b56
MD5 7e232b285bd6443537a6bd69a62b4a84
BLAKE2b-256 fe93a31f67e280b47aa143fb9000b0b2a0b59448577f863bac74cb3ddd3af4cc

See more details on using hashes here.

File details

Details for the file stcal-1.20.0-cp314-cp314-macosx_10_15_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.20.0-cp314-cp314-macosx_10_15_x86_64.whl
Algorithm Hash digest
SHA256 46d69ef5bb6db65840fd4bff75d6f94c9a631adf1150254fcfcc7492f052c595
MD5 fc368224a85d14d95f356af4cfae41e8
BLAKE2b-256 e569b05e61fa74ffcb3378a4ec4cde3fe157ac11d3906213cffae26a261a3a86

See more details on using hashes here.

File details

Details for the file stcal-1.20.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.20.0-cp313-cp313-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 9d1f7bed4ca80cc256ab5567c3a99d3ef967b3bd8f6477eb6907e7240f58c1bb
MD5 0bf14805df471d03d34bc7458423b8f2
BLAKE2b-256 e7f4c27851ddb7aec51c81adae060ec24d2b0c69f816fba14b3f2541515f9654

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.20.0-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0d2024d72023fc46a2c0c191666c5ae31873c706ad96d3fce504cff9dd0ec522
MD5 5a321572d5c2fbe77185942a4f515a83
BLAKE2b-256 e7e8c29d53154e58665cd858e874ae113b5322b3415bb19574e4b4dca9718f42

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.20.0-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 41ee9d9bf9a73925fa2efbbac80e57716ada8b3c81dd5d3124abf42b1f925542
MD5 be791384b17e5d11299ca8e066fe254e
BLAKE2b-256 92b3e9891555fd463cf95fed289da3823d33d879f78f625da996275f94709ad5

See more details on using hashes here.

File details

Details for the file stcal-1.20.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.20.0-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 0c07ec3ebde7610fba6e9ca53baa149c2791b9c7a540b805c5bfb4d091c141ff
MD5 00e63a3b349c4ce08739231c7044653c
BLAKE2b-256 095fee13b26fec4306e0f259e07573e3b5df4ef736e4466d6e07a59ad78bbca0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.20.0-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5585f1c19fae1a864567ce1fc691534cf6bf593e79d11e27a1ffeab2ad0a3197
MD5 2656cdc01cf6792e7ebc1aad2eb32528
BLAKE2b-256 51943d19ca7bb0e98f6d370185a710724d7391aa2b69c85f9a4fa70e68e4a4f8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.20.0-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 431bc2b889c3dbce04b1d4a668023a1fbcc198a5726dc363ea288e92d10508b5
MD5 4ad033696781b1c5f841b5a3e2b2002d
BLAKE2b-256 751d02b0b792bcb90835ec8945fb444a0a7be42e508cf326e31eda95d5aed6c0

See more details on using hashes here.

File details

Details for the file stcal-1.20.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for stcal-1.20.0-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 036f72e38cdec6b3708b33f50267089a73215c1e1a888b91a4a91a9a01bd4948
MD5 e1722e34909c142c594c102fab4b1678
BLAKE2b-256 01caf21a261e20e44938bbd19183c30ac3610cb38559af299e676fa31d5a9c8c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.20.0-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e73c9e5e490f8334c5a2a949bca84824468d0517c2b9b17b85867b9ab25bfd5a
MD5 436b2a3f107fc193fd318849d85c6337
BLAKE2b-256 4b49cdcaa82e94587f81e5d88091507923a8cc69216959875f3c3ca14a5fe0b3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for stcal-1.20.0-cp311-cp311-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e63984805c5bf509e295c96dafc71e1bd98b8340c877ef6407ba7adf58dc1a37
MD5 c01b270707f957dc1031e16518d37326
BLAKE2b-256 7586b200e06e986593f669cef2378cd11278afc1d366cc028cb6b04dec653b86

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.20.0 This release

13 files

1.19.1

13 files

1.19.0

13 files

1.18.0

13 files

1.17.0

13 files

1.16.0

13 files

1.15.2

10 files

1.15.1

10 files

1.15.0

10 files

1.14.1

10 files

1.13.0

10 files

1.12.0

10 files

1.11.1

13 files

1.11.0

10 files

1.10.0

10 files

1.9.0

10 files

1.8.2

10 files

1.8.1

10 files

1.8.0

10 files

1.7.3

10 files

1.7.2

10 files

1.7.1

10 files

1.7.0

10 files

1.6.1

13 files

1.6.0

13 files

1.5.2

13 files

1.5.1

13 files

1.5.0

12 files

1.4.4

7 files

1.4.3

7 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.7.3

2 files

0.7.2

2 files

0.7.1

2 files

0.7.0

2 files

0.6.4

2 files

0.6.3

2 files

0.6.2

2 files

0.6.1

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.3

2 files

0.4.2

1 file

0.4.1

1 file

0.4.0

1 file

0.3.0

1 file

0.2.5

1 file

0.2.4

1 file

0.2.3

1 file

0.2.2

1 file

0.2.1

2 files

0.2.0

1 file

0.1.1

1 file

Supported by

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