From 602f0e933d9e88ea06c329837439c7c4e613880f Mon Sep 17 00:00:00 2001 From: ilikecubesnstuff <25328250+ilikecubesnstuff@users.noreply.github.com> Date: Sun, 14 Jan 2024 07:46:29 +0000 Subject: [PATCH] :memo: Update README. --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7f0d8b2..5e9397b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ -# pydgin +# pidgey -A galactic dynamics interface (a [pidgin](https://en.wikipedia.org/wiki/Pidgin), if you will) using existing galactic dynamics libraries in Python (`galpy`, `gala` and `agama`) as backends. +[![PyPI - Version](https://img.shields.io/pypi/v/pidgey)](https://pypi.org/project/pidgey/) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pidgey)](https://pypi.org/project/pidgey/) +[![tests](https://github.com/ilikecubesnstuff/pidgey/actions/workflows/tests.yml/badge.svg)](https://github.com/ilikecubesnstuff/pidgey/actions/workflows/tests.yml) +[![pdm-managed](https://img.shields.io/badge/pdm-managed-blueviolet)](https://pdm.fming.dev) +[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) +[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) + +A pythin interface for dynamics of galaxies, using existing galactic dynamics libraries in Python ([`galpy`](https://github.com/jobovy/galpy), [`gala`](https://github.com/adrn/gala) and [`agama`](https://github.com/GalacticDynamics-Oxford/Agama)) as backends. + +This is currently used in the [commensurability](https://github.com/ilikecubesnstuff/commensurability/) library.