{"id":20603529,"url":"https://github.com/galacticdynamics/galactic_dynamics_interoperability","last_synced_at":"2025-04-15T02:01:08.833Z","repository":{"id":257147185,"uuid":"830304369","full_name":"GalacticDynamics/galactic_dynamics_interoperability","owner":"GalacticDynamics","description":"Interoperability Between Galactic Dynamics Libraries","archived":false,"fork":false,"pushed_at":"2025-04-07T19:50:26.000Z","size":32,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T20:41:03.373Z","etag":null,"topics":["galactic-dynamics","interoperability"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/GalacticDynamics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-18T02:51:44.000Z","updated_at":"2025-03-01T18:15:46.000Z","dependencies_parsed_at":"2025-04-07T20:40:56.499Z","dependency_job_id":null,"html_url":"https://github.com/GalacticDynamics/galactic_dynamics_interoperability","commit_stats":null,"previous_names":["galacticdynamics/galactic_dynamics_interoperability"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GalacticDynamics%2Fgalactic_dynamics_interoperability","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GalacticDynamics%2Fgalactic_dynamics_interoperability/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GalacticDynamics%2Fgalactic_dynamics_interoperability/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GalacticDynamics%2Fgalactic_dynamics_interoperability/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GalacticDynamics","download_url":"https://codeload.github.com/GalacticDynamics/galactic_dynamics_interoperability/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248991546,"owners_count":21194894,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["galactic-dynamics","interoperability"],"created_at":"2024-11-16T09:17:42.210Z","updated_at":"2025-04-15T02:01:08.816Z","avatar_url":"https://github.com/GalacticDynamics.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align='center'\u003e galactic_dynamics_interoperability \u003c/h1\u003e\n\u003ch2 align=\"center\"\u003e Interoperability Between Galactic Dynamics Libraries \u003c/h2\u003e\n\n\u003e [!WARNING]\n\u003e This package is under active development and is not ready for public use.\n\n`galactic_dynamics_interoperability` provides tools for converting objects\nbetween galactic dynamics Python libraries.\n\n## Installation\n\n[![PyPI platforms][pypi-platforms]][pypi-link]\n[![PyPI version][pypi-version]][pypi-link]\n\n```bash\npip install galactic_dynamics_interoperability\n```\n\n## Documentation\n\n[![Documentation Status][rtd-badge]][rtd-link]\n\nThe main docs are in development.\n\n### Quick Start\n\n`galactic_dynamics_interoperability` provides type objects for representing\ndifferent galactic dynamics libraries. These types are used for dispatching to\nconverters:\n\n- `AbstractInteroperableLibrary` : the base class\n- `AgamaLibrary` : represents [`agama`][Agama]\n- `GalaLibrary` : represents [`gala`][Gala]\n- `GalaxLibrary` : represents [`galax`][Galax]\n- `GalpyLibrary` : represents [`galpy`][Galpy]\n\nTo convert potential objects between libraries use `convert_potential`. As an\nexample, here is converting from a `gala` Potential to a `galax` Potential.\n\n```pycon\n\u003e\u003e\u003e from galactic_dynamics_interoperability import convert_potential, GalaxLibrary\n\u003e\u003e\u003e import gala.potential\n\u003e\u003e\u003e from gala.units import galactic\n\u003e\u003e\u003e import galax.potential\n\n\u003e\u003e\u003e potential = gala.potential.KeplerPotential(m=1e11, units=galactic)\n\u003e\u003e\u003e convert_potential(GalaxLibrary, potential)\nKeplerPotential(\n    units=LTMAUnitSystem( length=Unit(\"kpc\"), ...),\n    constants=ImmutableMap({'G': ...}),\n    m_tot=ConstantParameter( value=Quantity[...](value=f64[], unit=Unit(\"solMass\")) )\n)\n```\n\n### Q \u0026 A\n\n- _Why have the argument order `convert_potential(to, from)`, not\n  `convert_potential(from, to)`?_\n\n  This is because of how Julia structures its conversions\n  ([`convert`](https://docs.julialang.org/en/v1/base/base/#Base.convert)), from\n  which this library draws inspiration. We aim to increase interoperability\n  between galactic dynamics libraries and with the ongoing development of\n  [Python-Julia bridges](https://juliapackages.com/p/pythoncall),\n  Julia-wrapped-into-Python galactic dynamics libraries are well within our\n  remit.\n\n## Citation\n\n[![DOI][zenodo-badge]][zenodo-link]\n\nIf you found this library to be useful and want to support the development and\nmaintenance of lower-level code libraries for the scientific community, please\nconsider citing this work.\n\n## Development\n\n[![codecov][codecov-badge]][codecov-link]\n[![Actions Status][actions-badge]][actions-link]\n[![GitHub Discussion][github-discussions-badge]][github-discussions-link]\n\nWe welcome contributions!\n\n\u003c!-- prettier-ignore-start --\u003e\n\n\u003c!-- Links --\u003e\n\n[Agama]:                    https://pypi.org/project/agama/\n[Gala]:                     https://pypi.org/project/gala/\n[Galax]:                    https://pypi.org/project/galax/\n[Galpy]:                    https://pypi.org/project/galpy/\n\n\u003c!-- Badges --\u003e\n\n[actions-badge]:            https://github.com/GalacticDynamics/galactic_dynamics_interoperability/workflows/CI/badge.svg\n[actions-link]:             https://github.com/GalacticDynamics/galactic_dynamics_interoperability/actions\n[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions\u0026message=Ask\u0026color=blue\u0026logo=github\n[codecov-badge]:            https://codecov.io/gh/GalacticDynamics/galactic_dynamics_interoperability/graph/badge.svg\n[codecov-link]:             https://codecov.io/gh/GalacticDynamics/galactic_dynamics_interoperability\n[github-discussions-link]:  https://github.com/GalacticDynamics/galactic_dynamics_interoperability/discussions\n[pypi-link]:                https://pypi.org/project/galactic_dynamics_interoperability/\n[pypi-platforms]:           https://img.shields.io/pypi/pyversions/galactic_dynamics_interoperability\n[pypi-version]:             https://img.shields.io/pypi/v/galactic_dynamics_interoperability\n[rtd-badge]:                https://readthedocs.org/projects/galactic_dynamics_interoperability/badge/?version=latest\n[rtd-link]:                 https://galactic_dynamics_interoperability.readthedocs.io/en/latest/?badge=latest\n[zenodo-badge]:             https://zenodo.org/badge/755708966.svg\n[zenodo-link]:              https://zenodo.org/doi/10.5281/zenodo.10850557\n\n\u003c!-- prettier-ignore-end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalacticdynamics%2Fgalactic_dynamics_interoperability","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalacticdynamics%2Fgalactic_dynamics_interoperability","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalacticdynamics%2Fgalactic_dynamics_interoperability/lists"}