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 the rich library 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.