/galpy

Galactic Dynamics in python

Primary LanguagePythonOtherNOASSERTION

galpy

Galactic Dynamics in python

https://travis-ci.org/jobovy/galpy.svg?branch=master http://codecov.io/github/jobovy/galpy/coverage.svg?branch=master https://readthedocs.org/projects/galpy/badge/?version=latest

AUTHOR

Jo Bovy - bovy at ias dot edu

See AUTHORS.txt for a full list of contributors.

If you find this code useful in your research, please let me know. If you use galpy in a publication, please cite Bovy (2015) and link to http://github.com/jobovy/galpy. Please also send me a reference to the paper or send a pull request including your paper in the list of galpy papers on this page (this page is at doc/source/index.rst). Thanks!

DOCUMENTATION

The latest documentation can be found here. An alternative that is kept up-to-date less frequently is here.

PYTHON VERSIONS AND DEPENDENCIES

galpy supports both Python 2 and 3. Specifically, galpy supports Python 2.7 and Python 3.3 and 3.4. It may also work on earlier Python 3.* versions, but this has not been tested. Travis CI builds regularly check support for Python 2.7 and 3.4.

This package requires Numpy, Scipy, and Matplotlib. Certain advanced features require the GNU Scientific Library (GSL), with action calculations requiring version 1.14 or higher. Use of SnapshotRZPotential and InterpSnapshotRZPotential requires pynbody.

ISSUES

If you find any bug in the code, please report these using the Issue Tracker or by emailing the maintainer of the code.

If you are having issues with the installation of galpy, please first consult the Installation FAQ.

CONTRIBUTING TO GALPY

Some development notes can be found on the wiki. This includes a list of small and larger extensions of galpy that would be useful here as well as a longer-term roadmap here. Please let the main developer know if you need any help contributing!

DETAILED BUILD, COVERAGE, AND DOCUMENTATION STATUS

master:

https://travis-ci.org/jobovy/galpy.svg?branch=master http://codecov.io/github/jobovy/galpy/coverage.svg?branch=master https://readthedocs.org/projects/galpy/badge/?branch=master?version=latest

development branch (if it exists):

https://travis-ci.org/jobovy/galpy.svg?branch=dev https://img.shields.io/coveralls/jobovy/galpy.svg?branch=dev http://codecov.io/github/jobovy/galpy/coverage.svg?branch=dev https://readthedocs.org/projects/galpy/badge/?branch=master?version=latest

DISK DF CORRECTIONS

The dehnendf and shudf disk distribution functions can be corrected to follow the desired surface-mass density and radial-velocity-dispersion profiles more closely (see 1999AJ....118.1201D). Calculating these corrections is expensive, and a large set of precalculated corrections can be found here [tar.gz archive]. Install these by downloading them and unpacking them into the galpy/df_src/data directory before running the setup.py installation. E.g.:

curl -O https://cloud.github.com/downloads/jobovy/galpy/galpy-dfcorrections.tar.gz
tar xvzf galpy-dfcorrections.tar.gz -C ./galpy/df_src/data/