COOLEST

COOLEST: COde-independent Organized LEns STandard - Published in JOSS (2023)

https://github.com/aymgal/coolest

Science Score: 100.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 7 DOI reference(s) in README and JOSS metadata
✓
Academic publication links
Links to: joss.theoj.org
✓
Committers with academic emails
2 of 7 committers (28.6%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Keywords

astrophysics gravitational-lensing lens-modeling standardization

Scientific Fields

Mathematics Computer Science - 84% confidence

Last synced: 4 months ago · JSON representation ·

Repository

Standard for strong gravitational lensing analyses

Basic Info

Host: GitHub
Owner: aymgal
License: gpl-3.0
Language: Python
Default Branch: main
Homepage: https://coolest.readthedocs.io/
Size: 38.8 MB

Statistics

Stars: 18
Watchers: 4
Forks: 3
Open Issues: 7
Releases: 2

Topics

astrophysics gravitational-lensing lens-modeling standardization

Created over 4 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog Contributing License Citation Authors

Standard for Strong Gravitational Lensing Analyses

License

What is COOLEST?

The COde-independent Organized LEns STandard (COOLEST) defines a set of conventions to be shared across the strong lensing community, in order to consistently store, share and improve lens modeling analyses. In short, this project provides tools to manipulate lens models as a single, human-readable JSON template file alongside Python routines for visualizing and comparing lens models possibly obtained from different modeling codes.

For more information and the full list of COOLEST features, refer to the online documentation.

Components of the standard

COOLEST is composed of three distinct building blocks:

A set of conventions: reference point for all modelling assumptions and codes, which includes coordinate systems, units and profile definitions used when manipulating the lens models stored in the template file;
Template file system (coolest.template): a Python interface to create, store and manipulate COOLEST template files (JSON format) and linked external files (such as FITS files for data and pixelated model components);
Analysis & plotting (coolest.api): a Python interface to compute key lensing quantities and generate publication-ready lens model plots.

Examples

See the example notebooks directory to generate and manipulate typical JSON template files describing lens models. Below is an example of plot generated using the coolest.api submodule.

Example lens model comparison using the COOLEST plotting and analysis capabilities

Installation of the Python package

Latest released version

The easiest way to install the latest version of the coolest Python package is via PyPi: ```bash

Activate your virtual environment before if needed

pip install coolest ```

Latest development version

You can also install it from the GitHub repository directly to get access to the latest changes: ```bash

Clone the latest version

git clone https://github.com/aymgal/COOLEST.git

Move to the repo directly

cd COOLEST

Now is a good idea to activate your virtual environment if needed

```

Then you can install the coolest package. If you wish to modify or contribute to the source code, do not forget to use the -e option in the commands below to install it in development mode. For installing the package without optional dependencies, use the following command: ```bash

install coolest and required dependencies

pip install [-e] . For installing the package with all optional dependencies, use the following command:bash

also install optional dependencies

pip install [-e] ".[opt]" ```

You can test the installation by running python -c "import coolest" in the terminal, or by running some of the example notebooks from the documentation directory. Moreover, you can run all unit tests (having pytest installed in your environment), with the command pytest test.

Contributing to the COOLEST standard

We encourage and highly value All types of feedback, feature proposals and contributions from the whole lensing community. Please have a look at CONTRIBUTING.md for more information about contributing to the project.

Citing the COOLEST standard

If you make use of COOLEST for your research, please cite our JOSS publication. Here is the corresponding BibTeX entry:

@article{Galan2023, author = {Galan, Aymeric and de Vyvere, Lyne Van and Gomer, Matthew R. and Vernardos, Georgios and Sluse, Dominique}, doi = {10.21105/joss.05567}, journal = {Journal of Open Source Software}, month = aug, number = {88}, pages = {5567}, title = {{COOLEST: COde-independent Organized LEns STandard}}, url = {https://joss.theoj.org/papers/10.21105/joss.05567}, volume = {8}, year = {2023} }

Original contributors

The full list of contributors is given in AUTHORS.md.

As this is an open source project, we very much appreciate any feedback and new contributions from the community. The goal is really to improve the standard so that most of the research using strong lens modeling can benefit from it.

Owner

Name: Aymeric Galan
Login: aymgal
Kind: user

Repositories: 6
Profile: https://github.com/aymgal

PhD in Observational Cosmology Currently postdoc at LASTRO, EPFL.

JOSS Publication

COOLEST: COde-independent Organized LEns STandard

Published

August 09, 2023

DOI

10.21105/joss.05567

Volume 8, Issue 88, Page 5567

Authors

Aymeric Galan

Institute of Physics, Laboratory of Astrophysics, École Polytechnique Fédérale de Lausanne (EPFL), Switzerland, Technical University of Munich, TUM School of Natural Sciences, Department of Physics, James-Franck-Strasse 1, 85748 Garching, Germany

Lyne Van de Vyvere

STAR Institute, Quartier Agora, Allée du Six Août, 19c, 4000 Liège, Belgium

Matthew R. Gomer

STAR Institute, Quartier Agora, Allée du Six Août, 19c, 4000 Liège, Belgium

Georgios Vernardos

Institute of Physics, Laboratory of Astrophysics, École Polytechnique Fédérale de Lausanne (EPFL), Switzerland, Department of Physics and Astronomy, Lehman College, City University of New York, 250 Bedford Park Boulevard West, Bronx, NY 10468-1589, USA

Dominique Sluse

STAR Institute, Quartier Agora, Allée du Six Août, 19c, 4000 Liège, Belgium

Editor

Paul La Plante

Citation (CITATION.cff)

cff-version: "1.2.0"
authors:
- family-names: Galan
  given-names: Aymeric
  orcid: "https://orcid.org/0000-0003-2547-9815"
- family-names: Vyvere
  given-names: Lyne Van
  name-particle: de
  orcid: "https://orcid.org/0000-0002-0585-4203"
- family-names: Gomer
  given-names: Matthew R.
  orcid: "https://orcid.org/0000-0001-5562-3879"
- family-names: Vernardos
  given-names: Georgios
  orcid: "https://orcid.org/0000-0001-8554-7248"
- family-names: Sluse
  given-names: Dominique
  orcid: "https://orcid.org/0000-0001-6116-2095"
contact:
- family-names: Galan
  given-names: Aymeric
  orcid: "https://orcid.org/0000-0003-2547-9815"
doi: 10.5281/zenodo.8207512
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Galan
    given-names: Aymeric
    orcid: "https://orcid.org/0000-0003-2547-9815"
  - family-names: Vyvere
    given-names: Lyne Van
    name-particle: de
    orcid: "https://orcid.org/0000-0002-0585-4203"
  - family-names: Gomer
    given-names: Matthew R.
    orcid: "https://orcid.org/0000-0001-5562-3879"
  - family-names: Vernardos
    given-names: Georgios
    orcid: "https://orcid.org/0000-0001-8554-7248"
  - family-names: Sluse
    given-names: Dominique
    orcid: "https://orcid.org/0000-0001-6116-2095"
  date-published: 2023-08-09
  doi: 10.21105/joss.05567
  issn: 2475-9066
  issue: 88
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 5567
  title: "COOLEST: COde-independent Organized LEns STandard"
  type: article
  url: "https://joss.theoj.org/papers/10.21105/joss.05567"
  volume: 8
title: "COOLEST: COde-independent Organized LEns STandard"

GitHub Events

Total

Issues event: 1
Watch event: 1
Issue comment event: 2
Push event: 1

Last Year

Issues event: 1
Watch event: 1
Issue comment event: 2
Push event: 1

Committers

Last synced: 5 months ago

All Time

Total Commits: 482
Total Committers: 7
Avg Commits per committer: 68.857
Development Distribution Score (DDS): 0.151

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Aymeric Galan	a**n@g**m	409
LyneVdV	4****V	34
gvernard	g**d@a**l	32
mattgomer	m**r@g**m	4
Dan F-M	f**y@g**m	1
IPHYS-GE	I**E@t**h	1
IPHYS-GE	I**E@I**n	1

Committer Domains (Top 20 + Academic)

iphys-it.lan: 1 tsf-476-wpa-1-020.epfl.ch: 1 astro.rug.nl: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 23
Total pull requests: 44
Average time to close issues: about 1 month
Average time to close pull requests: 2 days
Total issue authors: 8
Total pull request authors: 4
Average comments per issue: 1.83
Average comments per pull request: 0.73
Merged pull requests: 38
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 2
Pull requests: 1
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 2
Pull request authors: 1
Average comments per issue: 1.5
Average comments per pull request: 0.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

gvernard (5)
AlexandreAdam (5)
LyneVdV (5)
nkhadka21 (2)
aymgal (2)
sibirrer (1)
HRSAstro (1)
musoke (1)

Pull Request Authors

aymgal (23)
LyneVdV (13)
gvernard (10)

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- pypi 217 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 4
Total maintainers: 1

pypi.org: coolest

Standard for Strong Gravitational Lensing Analyses

Homepage: https://github.com/aymgal/COOLEST
Documentation: https://coolest.readthedocs.io/
License: GPL-3.0
Latest release: 0.1.9
published over 1 year ago

Versions: 4
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 217 Last month

Rankings

Dependent packages count: 9.5%

Stargazers count: 18.1%

Forks count: 19.3%

Average: 27.5%

Dependent repos count: 62.9%

Maintainers (1)

aymgal

Last synced: 4 months ago

Dependencies

requirements.txt pypi

numpy *

Gemfile rubygems

coveralls >= 0

.github/workflows/ci-tests.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite
coverallsapp/github-action master composite

.github/workflows/draft-pdf.yml actions

actions/checkout v3 composite
actions/upload-artifact v1 composite
openjournals/openjournals-draft-action master composite

requirements_docs.txt pypi

ipython *
jupytext *
matplotlib *
myst-nb *
numpy *
scipy *
sphinx *
sphinx-autoapi *
sphinx-autobuild *
sphinx-book-theme *
sphinx-design *
sphinx-math-dollar *
sphinxcontrib.bibtex *

requirements_tests.txt pypi

lenstronomy ==1.11.0 test
pytest * test

setup.py pypi

astropy >=4.2.0
jsonpickle >=2.0.0
numpy >=1.20.0
scipy >=1.6.3

.github/workflows/publish-package.yml actions

actions/checkout v4 composite
actions/download-artifact v3 composite
actions/setup-python v4 composite
actions/upload-artifact v3 composite
pypa/gh-action-pypi-publish release/v1 composite
sigstore/gh-action-sigstore-python v1.2.3 composite

pyproject.toml pypi

COOLEST

Science Score: 100.0%

Keywords

Scientific Fields

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Standard for Strong Gravitational Lensing Analyses

What is COOLEST?

Components of the standard

Examples

Installation of the Python package

Latest released version

Activate your virtual environment before if needed

Latest development version

Clone the latest version

Move to the repo directly

Now is a good idea to activate your virtual environment if needed

install coolest and required dependencies

also install optional dependencies

Contributing to the COOLEST standard

Citing the COOLEST standard

Original contributors

Owner

JOSS Publication

COOLEST: COde-independent Organized LEns STandard

Authors

Editor

Tags

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: coolest

Rankings

Maintainers (1)

Dependencies