| Name | crds JSON |
| Version |
12.0.9
JSON |
| download |
| home_page | None |
| Summary | Calibration Reference Data System, HST/JWST/Roman reference file management |
| upload_time | 2024-12-27 22:07:35 |
| maintainer | None |
| docs_url | None |
| author | STScI CRDS s/w developers |
| requires_python | None |
| license | # Copyright (C) 2010 Association of Universities for Research in Astronomy(AURA) # # 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. The name of AURA and its representatives may not be used to # endorse or promote products derived from this software without # specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY AURA ``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 AURA 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 |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
====
CRDS
====
CRDS is a package used for working with astronomical reference files for the
HST and JWST telescopes. CRDS is useful for performing various operations on
reference files or reference file assignment rules. CRDS is used to assign,
check, and compare reference files and rules, and also to predict those
datasets which should potentially be reprocessed due to changes in reference
files or assignment rules. CRDS has versioned rules which define the
assignment of references for each type and instrument configuration. CRDS has
web sites corresponding to each project (http://hst-crds.stsci.edu or
https://jwst-crds.stsci.edu/) which record information about reference files
and provide related services.
CRDS development is occuring at:
`Project's github page <https://github.com/spacetelescope/crds>`_.
CRDS is also available for installation as part of ``stenv``:
`stenv <https://github.com/spacetelescope/stenv>`_.
Basic CRDS Installation
-----------------------
For many roles, CRDS is *automatically installed as a dependency* of the
calibration software. This default installation supports running calibrations
but not more advanced CRDS activities like submitting files or development.
You can test for an existing installation of CRDS like this::
$ crds list --status
CRDS Version = '7.4.0, b7.4.0, daf308e24c8dd37e70c89012e464058861417245'
CRDS_MODE = 'auto'
CRDS_PATH = 'undefined'
CRDS_SERVER_URL = 'undefined'
Cache Locking = 'enabled, multiprocessing'
Effective Context = 'jwst_0541.pmap'
Last Synced = '2019-08-26 07:30:09.254136'
Python Executable = '/Users/homer/miniconda3/envs/crds-env/bin/python'
Python Version = '3.7.4.final.0'
Readonly Cache = False
This output indicates CRDS is installed and configured for processing onsite
using a pre-built cache of CRDS rules and references at */grp/crds/cache*.
File Submission Installation
----------------------------
For performing the file submission role, CRDS includes additional dependencies
and can be trickier to install.
Adding CRDS to an Existing Environment
+++++++++++++++++++++++++++++++++++++++
You can install/upgrade CRDS and it's dependencies in your current environment
like this::
git clone https://github.com/spacetelescope/crds.git
cd crds
./crds_setup_crds
It is recommended that you only do this in an environment dedicated to file
submissions. This may be suitable for e.g. installing/upgrading CRDS in
an active *redcatconda* environment.
Full Environment Install
++++++++++++++++++++++++
Sometimes it's expedient to install an entirely new environment including a
baseline conda, CRDS, and all of it's dependencies. To start from scratch,
you can::
git clone https://github.com/spacetelescope/crds.git
cd crds
./crds_setup_all
# open a new terminal window
conda activate crds-env
To customize a bit more, *crds_setup_all* and *crds_setup_env* support
parameters which can be used to specify OS, shell, and install location.
Substitute the below to specify Linux, c-shell, and a non-default install
location::
./crds_setup_all Linux csh $HOME/miniconda_crds
Advanced Install
++++++++++++++++
Below are the current sub-tasks used conceptually for a full featured CRDS
install. These can serve as an alternative to cloning the CRDS repo and
running the install script(s). If you already have a python environment
supporting pip,
1. Installing Conda
^^^^^^^^^^^^^^^^^^^
Alternate / definitive installation instructions for installing a baseline conda
can be found here::
https://spacetelescope.github.io/training-library/computer_setup.html#installing-conda
2. Create crds-env Environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The CRDS software and basic conda dependencies should be installed in an
isolated conda environment::
conda create -n crds-env
conda activate crds-env
You can substitute the environment name of your choice, e.g. *redcatconda* vs. *crds-env*.
3. Add JWST CAL S/W and Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Installing the JWST CAL S/W will also automatically install many dependencies of
a numerical computing environment::
pip install --upgrade numpy
pip install --upgrade git+https://github.com/spacetelescope/jwst
Note that these commands also install the latest version of CRDS from pip which
may not be current enough for ongoing reference file testing and
troubleshooting.
4. Install CRDS and Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This sequence first removes the CRDS installed automatically as part of
installing the *jwst* package and then installs the latest available CRDS
from github with advanced dependencies not needed for basic operation::
pip uninstall --yes crds
pip install --upgrade git+https://github.com/spacetelescope/crds.git#egg=crds["submission","test"]
A more full featured CRDS install is::
pip install --upgrade git+https://github.com/spacetelescope/crds.git#egg=crds["submission","dev","test","docs"]
5. Install Fitsverify
^^^^^^^^^^^^^^^^^^^^^
Since it is a C-based package fitsverify is not available using pip but is
available via conda on the astroconda channel::
conda config --add channels http://ssb.stsci.edu/astroconda
conda install --yes fitsverify
As part of an end-user setup installation of fitsverify is optional, CRDS
certify will run without it after issuing a warning, the CRDS server will run
fitsverify as part of its checks unless/until we stop using it altogether.
User's Guide
------------
More documentation about CRDS is available here:
https://jwst-crds.stsci.edu/static/users_guide/index.html
Raw data
{
"_id": null,
"home_page": null,
"name": "crds",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "STScI CRDS s/w developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/54/1f/93935f3a17ba06170b313c25a195dbfc90a047f3c37d3ceedac95dbc7dd4/crds-12.0.9.tar.gz",
"platform": "Linux",
"description": "====\nCRDS\n====\n\nCRDS is a package used for working with astronomical reference files for the\nHST and JWST telescopes. CRDS is useful for performing various operations on\nreference files or reference file assignment rules. CRDS is used to assign,\ncheck, and compare reference files and rules, and also to predict those\ndatasets which should potentially be reprocessed due to changes in reference\nfiles or assignment rules. CRDS has versioned rules which define the\nassignment of references for each type and instrument configuration. CRDS has\nweb sites corresponding to each project (http://hst-crds.stsci.edu or\nhttps://jwst-crds.stsci.edu/) which record information about reference files\nand provide related services.\n\nCRDS development is occuring at:\n `Project's github page <https://github.com/spacetelescope/crds>`_.\n\nCRDS is also available for installation as part of ``stenv``:\n `stenv <https://github.com/spacetelescope/stenv>`_.\n\nBasic CRDS Installation\n-----------------------\n\nFor many roles, CRDS is *automatically installed as a dependency* of the\ncalibration software. This default installation supports running calibrations\nbut not more advanced CRDS activities like submitting files or development.\n\nYou can test for an existing installation of CRDS like this::\n\n $ crds list --status\n CRDS Version = '7.4.0, b7.4.0, daf308e24c8dd37e70c89012e464058861417245'\n CRDS_MODE = 'auto'\n CRDS_PATH = 'undefined'\n CRDS_SERVER_URL = 'undefined'\n Cache Locking = 'enabled, multiprocessing'\n Effective Context = 'jwst_0541.pmap'\n Last Synced = '2019-08-26 07:30:09.254136'\n Python Executable = '/Users/homer/miniconda3/envs/crds-env/bin/python'\n Python Version = '3.7.4.final.0'\n Readonly Cache = False\n\nThis output indicates CRDS is installed and configured for processing onsite\nusing a pre-built cache of CRDS rules and references at */grp/crds/cache*.\n\nFile Submission Installation\n----------------------------\n\nFor performing the file submission role, CRDS includes additional dependencies\nand can be trickier to install.\n\nAdding CRDS to an Existing Environment\n+++++++++++++++++++++++++++++++++++++++\n\nYou can install/upgrade CRDS and it's dependencies in your current environment\nlike this::\n\n git clone https://github.com/spacetelescope/crds.git\n cd crds\n ./crds_setup_crds\n\nIt is recommended that you only do this in an environment dedicated to file\nsubmissions. This may be suitable for e.g. installing/upgrading CRDS in\nan active *redcatconda* environment.\n\nFull Environment Install\n++++++++++++++++++++++++\n\nSometimes it's expedient to install an entirely new environment including a\nbaseline conda, CRDS, and all of it's dependencies. To start from scratch,\nyou can::\n\n git clone https://github.com/spacetelescope/crds.git\n cd crds\n ./crds_setup_all\n\n # open a new terminal window\n conda activate crds-env\n\nTo customize a bit more, *crds_setup_all* and *crds_setup_env* support\nparameters which can be used to specify OS, shell, and install location.\nSubstitute the below to specify Linux, c-shell, and a non-default install\nlocation::\n\n ./crds_setup_all Linux csh $HOME/miniconda_crds\n\nAdvanced Install\n++++++++++++++++\n\nBelow are the current sub-tasks used conceptually for a full featured CRDS\ninstall. These can serve as an alternative to cloning the CRDS repo and\nrunning the install script(s). If you already have a python environment\nsupporting pip,\n\n1. Installing Conda\n^^^^^^^^^^^^^^^^^^^\n\nAlternate / definitive installation instructions for installing a baseline conda\ncan be found here::\n\n https://spacetelescope.github.io/training-library/computer_setup.html#installing-conda\n\n2. Create crds-env Environment\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThe CRDS software and basic conda dependencies should be installed in an\nisolated conda environment::\n\n conda create -n crds-env\n conda activate crds-env\n\nYou can substitute the environment name of your choice, e.g. *redcatconda* vs. *crds-env*.\n\n3. Add JWST CAL S/W and Dependencies\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nInstalling the JWST CAL S/W will also automatically install many dependencies of\na numerical computing environment::\n\n pip install --upgrade numpy\n pip install --upgrade git+https://github.com/spacetelescope/jwst\n\nNote that these commands also install the latest version of CRDS from pip which\nmay not be current enough for ongoing reference file testing and\ntroubleshooting.\n\n4. Install CRDS and Dependencies\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nThis sequence first removes the CRDS installed automatically as part of\ninstalling the *jwst* package and then installs the latest available CRDS\nfrom github with advanced dependencies not needed for basic operation::\n\n pip uninstall --yes crds\n pip install --upgrade git+https://github.com/spacetelescope/crds.git#egg=crds[\"submission\",\"test\"]\n\nA more full featured CRDS install is::\n\n pip install --upgrade git+https://github.com/spacetelescope/crds.git#egg=crds[\"submission\",\"dev\",\"test\",\"docs\"]\n\n5. Install Fitsverify\n^^^^^^^^^^^^^^^^^^^^^\n\nSince it is a C-based package fitsverify is not available using pip but is\navailable via conda on the astroconda channel::\n\n conda config --add channels http://ssb.stsci.edu/astroconda\n conda install --yes fitsverify\n\nAs part of an end-user setup installation of fitsverify is optional, CRDS\ncertify will run without it after issuing a warning, the CRDS server will run\nfitsverify as part of its checks unless/until we stop using it altogether.\n\nUser's Guide\n------------\n\nMore documentation about CRDS is available here:\n\n https://jwst-crds.stsci.edu/static/users_guide/index.html\n",
"bugtrack_url": null,
"license": "# Copyright (C) 2010 Association of Universities for Research in Astronomy(AURA) # # 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. The name of AURA and its representatives may not be used to # endorse or promote products derived from this software without # specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY AURA ``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 AURA 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": "Calibration Reference Data System, HST/JWST/Roman reference file management",
"version": "12.0.9",
"project_urls": {
"homepage": "https://github.com/spacetelescope/crds"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5c947b9f0d0b4a264f571568f33b9eaee263823544bb2a42f450a61ca1537b9",
"md5": "3a0d06dd4c5bf4f2c117e5e52e8110c6",
"sha256": "1c8786bd51c0501c6ac1d95a211e32bc918f1fd577816873c80a987cbffe314f"
},
"downloads": -1,
"filename": "crds-12.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a0d06dd4c5bf4f2c117e5e52e8110c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1153042,
"upload_time": "2024-12-27T22:07:31",
"upload_time_iso_8601": "2024-12-27T22:07:31.471816Z",
"url": "https://files.pythonhosted.org/packages/e5/c9/47b9f0d0b4a264f571568f33b9eaee263823544bb2a42f450a61ca1537b9/crds-12.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "541f93935f3a17ba06170b313c25a195dbfc90a047f3c37d3ceedac95dbc7dd4",
"md5": "7641aeef7db53402f34623d531021740",
"sha256": "8357ae6d69b22271f49eaa2a1b6d3b3187e6918150aaf4e2ae10f7484dbec631"
},
"downloads": -1,
"filename": "crds-12.0.9.tar.gz",
"has_sig": false,
"md5_digest": "7641aeef7db53402f34623d531021740",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14215603,
"upload_time": "2024-12-27T22:07:35",
"upload_time_iso_8601": "2024-12-27T22:07:35.228137Z",
"url": "https://files.pythonhosted.org/packages/54/1f/93935f3a17ba06170b313c25a195dbfc90a047f3c37d3ceedac95dbc7dd4/crds-12.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-27 22:07:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spacetelescope",
"github_project": "crds",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "crds"
}
