| 1 |
Metadata-Version: 2.2 |
| 2 |
Name: galpy |
| 3 |
Version: 1.10.2 |
| 4 |
Summary: Galactic Dynamics in python |
| 5 |
Home-page: http://github.com/jobovy/galpy |
| 6 |
Author: Jo Bovy |
| 7 |
Author-email: [email protected] |
| 8 |
License: New BSD |
| 9 |
Classifier: Development Status :: 6 - Mature |
| 10 |
Classifier: Intended Audience :: Science/Research |
| 11 |
Classifier: License :: OSI Approved :: BSD License |
| 12 |
Classifier: Operating System :: OS Independent |
| 13 |
Classifier: Programming Language :: C |
| 14 |
Classifier: Programming Language :: Python :: 3.8 |
| 15 |
Classifier: Programming Language :: Python :: 3.9 |
| 16 |
Classifier: Programming Language :: Python :: 3.10 |
| 17 |
Classifier: Programming Language :: Python :: 3.11 |
| 18 |
Classifier: Programming Language :: Python :: 3.12 |
| 19 |
Classifier: Programming Language :: Python :: 3.13 |
| 20 |
Classifier: Environment :: WebAssembly :: Emscripten |
| 21 |
Classifier: Topic :: Scientific/Engineering :: Astronomy |
| 22 |
Classifier: Topic :: Scientific/Engineering :: Physics |
| 23 |
Requires-Python: >=3.8 |
| 24 |
Description-Content-Type: text/markdown |
| 25 |
License-File: LICENSE |
| 26 |
License-File: AUTHORS.txt |
| 27 |
Requires-Dist: packaging |
| 28 |
Requires-Dist: numpy>=1.7 |
| 29 |
Requires-Dist: scipy |
| 30 |
Requires-Dist: matplotlib |
| 31 |
Provides-Extra: docs |
| 32 |
Requires-Dist: sphinxext-opengraph; extra == "docs" |
| 33 |
Requires-Dist: sphinx-design; extra == "docs" |
| 34 |
Requires-Dist: markupsafe==2.0.1; extra == "docs" |
| 35 |
Dynamic: author |
| 36 |
Dynamic: author-email |
| 37 |
Dynamic: classifier |
| 38 |
Dynamic: description |
| 39 |
Dynamic: description-content-type |
| 40 |
Dynamic: home-page |
| 41 |
Dynamic: license |
| 42 |
Dynamic: provides-extra |
| 43 |
Dynamic: requires-dist |
| 44 |
Dynamic: requires-python |
| 45 |
Dynamic: summary |
| 46 |
|
| 47 |
<p align="center"> |
| 48 |
<b>Galactic Dynamics in python</b> |
| 49 |
</p> |
| 50 |
|
| 51 |
[galpy](http://www.galpy.org) is a Python package for galactic dynamics. It supports orbit integration in a variety of potentials, evaluating and sampling various distribution functions, and the calculation of action-angle coordinates for all static potentials. `galpy` is an [astropy](http://www.astropy.org/) [affiliated package](http://www.astropy.org/affiliated/) and provides full support for astropy’s [Quantity](http://docs.astropy.org/en/stable/api/astropy.units.Quantity.html) framework for variables with units. |
| 52 |
|
| 53 |
|
| 54 |
AUTHOR |
| 55 |
====== |
| 56 |
|
| 57 |
Jo Bovy - bovy at astro dot utoronto dot ca |
| 58 |
|
| 59 |
See |
| 60 |
[AUTHORS.txt](https://github.com/jobovy/galpy/blob/main/AUTHORS.txt) |
| 61 |
for a full list of contributors. |
| 62 |
|
| 63 |
If you find this code useful in your research, please let me know. **If |
| 64 |
you use galpy in a publication, please cite** [Bovy |
| 65 |
(2015)](http://adsabs.harvard.edu/abs/2015ApJS..216...29B) **and link to |
| 66 |
http://github.com/jobovy/galpy**. See [the acknowledgement documentation |
| 67 |
section](http://docs.galpy.org/en/latest/index.html#acknowledging-galpy) |
| 68 |
for a more detailed guide to citing parts of the code. Thanks! |
| 69 |
|
| 70 |
LOOKING FOR HELP? |
| 71 |
================= |
| 72 |
|
| 73 |
The latest documentation can be found |
| 74 |
[here](http://docs.galpy.org/en/latest/). You can also join the |
| 75 |
[galpy slack community](https://galpy.slack.com/) for any questions |
| 76 |
related to `galpy`; join |
| 77 |
[here](https://join.slack.com/t/galpy/shared_invite/zt-p6upr4si-mX7u8MRdtm~3bW7o8NA_Ww). |
| 78 |
|
| 79 |
If you find *any* bug in the code, please report these using the [Issue |
| 80 |
Tracker](http://github.com/jobovy/galpy/issues) or by joining the [galpy |
| 81 |
slack community](https://galpy.slack.com/). |
| 82 |
|
| 83 |
If you are having issues with the installation of `galpy`, please first |
| 84 |
consult the [Installation |
| 85 |
FAQ](http://docs.galpy.org/en/latest/installation.html#installation-faq). |
| 86 |
|
| 87 |
PYTHON VERSIONS AND DEPENDENCIES |
| 88 |
================================ |
| 89 |
|
| 90 |
`galpy` supports Python 3. Specifically, galpy supports Python 3.8, 3.9, 3.10, 3.11, 3.12 |
| 91 |
and 3.13. GitHub Actions CI builds regularly check support for |
| 92 |
Python 3.13 (and of 3.8, 3.9, 3.10, 3.11, and 3.12 using a more limited, core set of tests) |
| 93 |
on Linux and Windows (and 3.13 on Mac OS). Python 2.7 is no longer supported. |
| 94 |
|
| 95 |
This package requires [Numpy](https://numpy.org/), |
| 96 |
[Scipy](http://www.scipy.org/), and |
| 97 |
[Matplotlib](http://matplotlib.sourceforge.net/). Certain advanced |
| 98 |
features require the GNU Scientific Library |
| 99 |
([GSL](http://www.gnu.org/software/gsl/)), with action calculations |
| 100 |
requiring version 1.14 or higher. Other optional dependencies include: |
| 101 |
|
| 102 |
* Support for providing inputs and getting outputs as Quantities with units is provided through |
| 103 |
[`astropy`](http://www.astropy.org/). |
| 104 |
* Querying SIMBAD for the coordinates of an object in the `Orbit.from_name` initialization method requires [`astroquery`](https://astroquery.readthedocs.io/en/latest/). |
| 105 |
* Displaying a progress bar for certain operations (e.g., orbit integration of multiple objects at once) requires [`tqdm`](https://github.com/tqdm/tqdm). |
| 106 |
* Plotting arbitrary functions of Orbit attributes requires [`numexpr`](https://github.com/pydata/numexpr). |
| 107 |
* Speeding up the evaluation of certain functions in the C code requires [`numba`](https://numba.pydata.org/). |
| 108 |
* Constant-anisotropy DFs in `galpy.df.constantbetadf` require [`JAX`](https://github.com/google/jax). |
| 109 |
* Use of `SnapshotRZPotential` and `InterpSnapshotRZPotential` requires [`pynbody`](https://github.com/pynbody/pynbody). |
| 110 |
|
| 111 |
Other parts of the code may require additional packages and you will be alerted by the code if they are |
| 112 |
not installed. |
| 113 |
|
| 114 |
CONTRIBUTING TO GALPY |
| 115 |
===================== |
| 116 |
|
| 117 |
If you are interested in contributing to galpy\'s development, take a |
| 118 |
look at [this brief |
| 119 |
guide](https://github.com/jobovy/galpy/wiki/Guide-for-new-contributors) |
| 120 |
on the wiki. This will hopefully help you get started! |
| 121 |
|
| 122 |
Some further development notes can be found on the |
| 123 |
[wiki](http://github.com/jobovy/galpy/wiki/). This includes a list of |
| 124 |
small and larger extensions of galpy that would be useful |
| 125 |
[here](http://github.com/jobovy/galpy/wiki/Possible-galpy-extensions) as |
| 126 |
well as a longer-term roadmap |
| 127 |
[here](http://github.com/jobovy/galpy/wiki/Roadmap). Please let the main |
| 128 |
developer know if you need any help contributing! |