surveycodex 1.2.0__tar.gz

surveycodex-1.2.0/.all-contributorsrc

@@ -0,0 +1,86 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "contributors": [
+    {
+      "login": "aboucaud",
+      "name": "Alexandre Boucaud",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3065310?v=4",
+      "profile": "https://aboucaud.github.io",
+      "contributions": [
+        "code",
+        "ideas",
+        "maintenance",
+        "review"
+      ]
+    },
+    {
+      "login": "mpaillassa",
+      "name": "mpaillassa",
+      "avatar_url": "https://avatars.githubusercontent.com/u/9745094?v=4",
+      "profile": "https://github.com/mpaillassa",
+      "contributions": [
+        "code",
+        "review",
+        "data"
+      ]
+    },
+    {
+      "login": "ismael-mendoza",
+      "name": "Ismael Mendoza",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11745764?v=4",
+      "profile": "https://ismael-mendoza.github.io/",
+      "contributions": [
+        "ideas",
+        "review",
+        "data"
+      ]
+    },
+    {
+      "login": "HironaoMiyatake",
+      "name": "Hironao Miyatake",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1507529?v=4",
+      "profile": "https://github.com/HironaoMiyatake",
+      "contributions": [
+        "code",
+        "data"
+      ]
+    },
+    {
+      "login": "aguinot",
+      "name": "Axel Guinot",
+      "avatar_url": "https://avatars.githubusercontent.com/u/39480528?v=4",
+      "profile": "https://github.com/aguinot",
+      "contributions": [
+        "data"
+      ]
+    },
+    {
+      "login": "thuiop",
+      "name": "thuiop",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1338337?v=4",
+      "profile": "https://github.com/thuiop",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "herjy",
+      "name": "Rémy Joseph",
+      "avatar_url": "https://avatars.githubusercontent.com/u/16084926?v=4",
+      "profile": "https://remyjoseph.wordpress.com/",
+      "contributions": [
+        "ideas"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "projectName": "surveycodex",
+  "projectOwner": "LSSTDESC",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "skipCi": true
+}

surveycodex-1.2.0/.github/workflows/check_style.yml

@@ -0,0 +1,16 @@
+name: "Check code style"
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    env:
+      SKIP: no-commit-to-branch
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/action@v3.0.1

surveycodex-1.2.0/.github/workflows/python-package.yml

@@ -0,0 +1,43 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install the library and dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r scripts/requirements.txt
+        pip install ".[dev]"
+    - name: Test the code demo
+      run: |
+        python -m surveycodex
+    - name: Test the console script
+      run: |
+        surveycodex --refs
+    - name: Test the scripts
+      run: |
+        for pyscript in scripts/*.py; do python ${pyscript}; done
+    - name: Test the utility functions
+      run: |
+        pytest --cov

surveycodex-1.2.0/.github/workflows/python-publish.yml

@@ -0,0 +1,37 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.9'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install wheel
+    - name: Build package
+      run: |
+        python setup.py sdist bdist_wheel
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

surveycodex-1.2.0/.gitignore

@@ -0,0 +1,144 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# End of https://www.toptal.com/developers/gitignore/api/python

surveycodex-1.2.0/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.6.0
+  hooks:
+    - id: check-merge-conflict
+    - id: check-yaml
+    - id: debug-statements
+    - id: end-of-file-fixer
+    - id: no-commit-to-branch
+      args: [--branch, main]
+    - id: requirements-txt-fixer
+    - id: trailing-whitespace
+      args: [--markdown-linebreak-ext=md]
+- repo: https://github.com/PyCQA/isort
+  rev: 5.13.2
+  hooks:
+    - id: isort
+      args: [--profile, black]
+- repo: https://github.com/asottile/pyupgrade
+  rev: v3.15.2
+  hooks:
+    - id: pyupgrade
+      args: [--py37-plus]
+- repo: https://github.com/PyCQA/flake8
+  rev: 7.0.0
+  hooks:
+   - id: flake8
+     args: ['--ignore=E501,E203,E731,W503']
+- repo: https://github.com/psf/black
+  rev: 24.3.0
+  hooks:
+    - id: black

surveycodex-1.2.0/CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing to `surveycodex`
+
+We appreciate that you want to contribute to `surveycodex`. Your time is valuable, and your contribution means a lot.
+
+## Important!
+
+By contributing to this project, you agree that the content you contribute may be provided under the project [license](LICENSE), which means that the numbers you provide for a given survey are public or can be made public.
+
+## Getting started
+
+**What does "contributing" mean?**
+
+There are several ways to contribute, namely:
+
+- Feature requests or bug reports through [issues](#issues)
+- Add, update or correct information through [pull-requests](#pull-requests)
+
+
+**Showing support for** `surveycodex`
+
+Don't have time to contribute? No worries, here are some other ways to show your support for `surveycodex`:
+
+- star the [project](https://github.com/LSSTDESC/surveycodex) (creates visibility)
+- mention it around
+
+## Issues
+
+To create an issue, go to https://github.com/LSSTDESC/surveycodex/issues/new, provide it with a meaningful title and a description, as well as labels if appropriate.
+
+## Pull-requests
+
+To add, update or correct information, the first step is to setup a development environment for `surveycodex` and then create feature branches for a given [pull-request](https://github.com/LSSTDESC/surveycodex/pulls).
+
+> Note that you will have to [fork the project](https://guides.github.com/activities/forking/) to contribute.
+
+### Getting a development environment (do once)
+
+- Clone the project
+    ```sh
+    git clone https://github.com/LSSTDESC/surveycodex
+    cd surveycodex
+    ```
+- Setup the virtual environment with the dev tools
+    ```sh
+    python -m venv venv
+    source venv/bin/activate
+    python -m pip install -U pip
+    ```
+- Install `surveycodex` with developer libs
+    ```sh
+    pip install -e ".[dev]"
+    ```
+- Install the automated checks and code lint on git commits
+    ```sh
+    pre-commit install
+    ```
+- Make sure to regularly run the tests and check code coverage
+    ```sh
+    pytest --cov
+    ```
+
+### Create a fork (do once)
+
+- [Fork the surveycodex project](https://guides.github.com/activities/forking/)
+- Add the fork to the list of remote servers
+    ```sh
+    git remote add fork git@github.com:<your username>/surveycodex.git
+    ```
+
+### Code in a feature branch
+
+1. Activate the development environment
+    ```sh
+    source venv/bin/activate
+    ```
+2. Create a feature branch (e.g. `featbranch` here)
+    ```sh
+    git checkout -b featbranch
+    ```
+3. Commit your code into `featbranch` (sometimes the commit will be rejected because of the `pre-commit` checks, just add the files a second time and commit again).
+4. Make sure to integrate the latest changes by regularly incorporating the latest work of the main branch into yours
+    ```sh
+    git rebase origin/main
+    ```
+    and solve the conflicts, if any.
+5. Push your feature branch to your fork
+    ```sh
+    git push -u fork featbranch  # the first time to set the target remote
+    git push                     # afterwards
+    ```
+6. Create [the pull-request](https://github.com/LSSTDESC/surveycodex/pulls) and iterate from 3. until it is merged.

surveycodex-1.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 BlendingToolkit developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

surveycodex-1.2.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.1
+Name: surveycodex
+Version: 1.2.0
+Summary: Tiny library of galaxy surveys most useful parameters with units
+Home-page: https://github.com/LSSTDESC/surveycodex
+Author: Alexandre Boucaud
+Author-email: aboucaud@apc.in2p3.fr
+License: MIT
+Project-URL: Bug Tracker, https://github.com/LSSTDESC/surveycodex/issues
+Platform: any
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+Provides-Extra: docs
+Provides-Extra: scripts
+License-File: LICENSE
+
+[**Main documentation**](https://aboucaud.github.io/galcheat/) | [**Getting started**](#getting-started) | [**CLI**](#cli) | [**API**](#api) | [**Contributing**](#contributing) | [**License**](#license)
+
+<!-- <br>
+<img src="docs/images/surveycodex_logo.png" alt="surveycodex" height=200px>
+</p> -->
+
+# SurveyCodex
+
+[![Python package][gh-workflow-badge]][gh-workflow]
+[![License][license-badge]](LICENSE)
+![Python supported versions][pyversion-badge]
+[![PyPI][pypi-badge]][pypi]<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+[gh-workflow]: https://github.com/LSSTDESC/surveycodex/actions/workflows/python-package.yml
+[gh-workflow-badge]: https://github.com/LSSTDESC/surveycodex/actions/workflows/python-package.yml/badge.svg
+[license-badge]: https://img.shields.io/github/license/LSSTDESC/surveycodex?color=blue
+[pyversion-badge]: https://img.shields.io/pypi/pyversions/surveycodex?color=yellow&logo=pypi
+[pypi-badge]: https://badge.fury.io/py/surveycodex.svg
+[pypi]: https://pypi.org/project/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](https://aboucaud.github.io/galcheat/parameters.html)
+
+Getting started
+---------------
+Install the latest version of the library
+```sh
+pip install -U surveycodex
+```
+
+CLI
+---
+
+Print the available surveys and associated filters
+
+```sh
+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
+```sh
+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
+---
+```python
+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)][github-btk] and [WeakLensingDeblending][github-wld] projects and has received contributions from these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://aboucaud.github.io"><img src="https://avatars.githubusercontent.com/u/3065310?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexandre Boucaud</b></sub></a><br /><a href="https://github.com/LSSTDESC/surveycodex/commits?author=aboucaud" title="Code">💻</a> <a href="#ideas-aboucaud" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-aboucaud" title="Maintenance">🚧</a> <a href="https://github.com/LSSTDESC/surveycodex/pulls?q=is%3Apr+reviewed-by%3ALSSTDESC" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/mpaillassa"><img src="https://avatars.githubusercontent.com/u/9745094?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mpaillassa</b></sub></a><br /><a href="https://github.com/LSSTDESC/surveycodex/commits?author=mpaillassa" title="Code">💻</a> <a href="https://github.com/LSSTDESC/surveycodex/pulls?q=is%3Apr+reviewed-by%3Ampaillassa" title="Reviewed Pull Requests">👀</a> <a href="#data-mpaillassa" title="Data">🔣</a></td>
+    <td align="center"><a href="https://ismael-mendoza.github.io/"><img src="https://avatars.githubusercontent.com/u/11745764?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ismael Mendoza</b></sub></a><br /><a href="#ideas-ismael-mendoza" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/LSSTDESC/surveycodex/pulls?q=is%3Apr+reviewed-by%3Aismael-mendoza" title="Reviewed Pull Requests">👀</a> <a href="#data-ismael-mendoza" title="Data">🔣</a></td>
+    <td align="center"><a href="https://github.com/HironaoMiyatake"><img src="https://avatars.githubusercontent.com/u/1507529?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hironao Miyatake</b></sub></a><br /><a href="https://github.com/LSSTDESC/surveycodex/commits?author=HironaoMiyatake" title="Code">💻</a> <a href="#data-HironaoMiyatake" title="Data">🔣</a></td>
+    <td align="center"><a href="https://github.com/aguinot"><img src="https://avatars.githubusercontent.com/u/39480528?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Axel Guinot</b></sub></a><br /><a href="#data-aguinot" title="Data">🔣</a></td>
+    <td align="center"><a href="https://github.com/thuiop"><img src="https://avatars.githubusercontent.com/u/1338337?v=4?s=100" width="100px;" alt=""/><br /><sub><b>thuiop</b></sub></a><br /><a href="#ideas-thuiop" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://remyjoseph.wordpress.com/"><img src="https://avatars.githubusercontent.com/u/16084926?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rémy Joseph</b></sub></a><br /><a href="#ideas-herjy" title="Ideas, Planning, & Feedback">🤔</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/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](CONTRIBUTING.md) to learn how to participate into making this library more robust and complete.
+
+[github-wld]: https://github.com/LSSTDESC/WeakLensingDeblending
+[github-btk]: https://github.com/LSSTDESC/BlendingToolKit
+
+License
+-------
+This project is developed under an MIT-license. See [LICENSE file](LICENSE) for more information.
+
+