Main documentation | Getting started | CLI | API | Contributing | License
SurveyCodex
Tiny package containing useful parameters from main galaxy surveys (with units).
The goal of this project is to provide a Python library with minimal dependencies that centralises galaxy survey properties with adequate reference. Such information tends to be scattered in many places or is often copy/pasted without all of the relevant information like units or sources.
The current parameters and the corresponding units are specified in the documentation
Getting started
Install the latest version of the library
pip install -U surveycodex
CLI
Print the available surveys and associated filters
surveycodex
Options
-s <survey>: print information for a given survey--refs: print the source for each parameter--rich: use pretty printing for the terminal (needs therichlibrary installed)-h, --help: get help
Examples
surveycodex -s LSST # LSST info
surveycodex --refs # all surveys info with refs
surveycodex --refs -s HSC # HSC info with refs
surveycodex -s LSST --rich # pretty print rich terminal output for LSST info
API
import surveycodex
# Start with the list of available surveys
surveycodex.available_surveys
# Retrieve a Survey instance
LSST = surveycodex.get_survey("LSST")
# List the available survey filters
LSST.available_filters
# Pick a Filter instance
u_band = LSST.get_filter("u")
# Both Survey and Filter objects have physical attributes
LSST.mirror_diameter
u_band.full_exposure_time
# These attributes are Astropy Quantity objects
# whose value can be retrieved in any desired unit
u_band.psf_fwhm.to_value('arcmin')
Contributing ✨
This project was started in the context of the BlendingToolKit (BTK) and WeakLensingDeblending projects and has received contributions from these wonderful people (emoji key):
Alexandre Boucaud 💻 🤔 🚧 👀 |
mpaillassa 💻 👀 🔣 |
Ismael Mendoza 🤔 👀 🔣 |
Hironao Miyatake 💻 🔣 |
Axel Guinot 🔣 |
thuiop 🤔 |
Rémy Joseph 🤔 |
This project follows the all-contributors specification.
A number is missing? An error slipped into the files? A survey is not included in the list and you can provide the relevant information or some of it?
Contributions of any kind are welcome! Head over to the contributing guidelines to learn how to participate into making this library more robust and complete.
License
This project is developed under an MIT-license. See LICENSE file for more information.
Metadata
Release files for surveycodex 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| surveycodex-1.3.0.tar.gz | 267.0 kB | Without provenance | Details for surveycodex-1.3.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| surveycodex-1.3.0-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for surveycodex-1.3.0-py2.py3-none-any.whl |
Total release size: 292.9 kB
Release files / surveycodex-1.3.0.tar.gz
| Download URL | surveycodex-1.3.0.tar.gz |
|---|---|
| Size | 267.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ce9783e05288719402d104a4e7973fd143f59372b33418f10764b280908a12dc
|
|
BLAKE2b-256 checksum How to use checksums |
e8ab802f65a414d683fbf391fc5ebe0dc5238bc638a0425e31347033b9f58dfc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / surveycodex-1.3.0-py2.py3-none-any.whl
| Download URL | surveycodex-1.3.0-py2.py3-none-any.whl |
|---|---|
| Size | 26.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
9fd35dad1a27625cbba356f2982b773bc76c8bb1b41c3719c3669bd185e3a531
|
|
BLAKE2b-256 checksum How to use checksums |
ed8b8d91d2061560145f0dd2839b32c622a939dc5814c146087b7f4d11ccb5a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for surveycodex 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.