Skip to content

Add info on citing FROG to README.md #975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexdewar merged 4 commits into from
Apr 23, 2026
Merged

Add info on citing FROG to README.md #975

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a75631d
README.md: Add info on citing FROG
alexdewar Apr 22, 2026
629fb7f
Move GitHub tag badge to below all contributors one
alexdewar Apr 22, 2026
3711a9d
README.md: Add badge for DOI
alexdewar Apr 22, 2026
0ce8c3e
Use HTTPS for mypy badge
alexdewar Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
![GitHub tag (with filter)](https://img.shields.io/github/v/tag/ImperialCollegeLondon/FROG)
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
![GitHub tag (with filter)](https://img.shields.io/github/v/tag/ImperialCollegeLondon/FROG)
[![GitHub](https://img.shields.io/github/license/ImperialCollegeLondon/FROG)](https://raw.githubusercontent.com/ImperialCollegeLondon/FROG/main/LICENCE.txt)
[![DOI](https://zenodo.org/badge/557238509.svg)](https://doi.org/10.5281/zenodo.19633886)
Comment thread
alexdewar marked this conversation as resolved.
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ImperialCollegeLondon/FROG/main.svg)](https://results.pre-commit.ci/latest/github/ImperialCollegeLondon/FROG/main)
[![Test and build](https://github.com/ImperialCollegeLondon/FROG/actions/workflows/ci.yml/badge.svg)](https://github.com/ImperialCollegeLondon/FROG/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/ImperialCollegeLondon/FROG/graph/badge.svg?token=4UILYHPMJT)](https://codecov.io/gh/ImperialCollegeLondon/FROG)
Expand Down Expand Up @@ -42,6 +43,12 @@ This work was supported by NERC (grant: NE/Y006216/1) and ESA (contract: 4000137
[UNIRAS]: https://www.imperial.ac.uk/space-and-atmospheric-physics/research/missions-and-projects/atmospheric-missions/uniras/
[Facility for Airborne Atmospheric Measurements]: https://www.faam.ac.uk/

## Citing this software

If you use FROG in your research, please cite us, including the version number. For information on how to cite FROG, see [the Zenodo page for the latest release][zenodo-latest].

[zenodo-latest]: https://doi.org/10.5281/zenodo.19633886
Comment thread
alexdewar marked this conversation as resolved.
Comment thread
alexdewar marked this conversation as resolved.

## For developers

Technical documentation is available on [FROG's GitHub Pages site](https://imperialcollegelondon.github.io/FROG/).
Expand Down
Loading