Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
34 changed files
with
634 additions
and
366 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Number of days of inactivity before an issue becomes stale | ||
| daysUntilStale: 60 | ||
| # Number of days of inactivity before a stale issue is closed | ||
| daysUntilClose: 7 | ||
| # Issues with these labels will never be considered stale | ||
| exemptLabels: | ||
| - pinned | ||
| - security | ||
| # Label to use when marking an issue as stale | ||
| staleLabel: wontfix | ||
| # Comment to post when marking an issue as stale. Set to `false` to disable | ||
| markComment: > | ||
| This issue has been automatically marked as stale because it has not had | ||
| recent activity. It will be closed if no further activity occurs. If the | ||
| issue has been resolved since the last activity, please close the issue. | ||
| Thank you for your contributions. | ||
| # Comment to post when closing a stale issue. Set to `false` to disable | ||
| closeComment: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| <p align="center"> | ||
| <a href="http://www.galpy.org" target="_blank"><img src="https://galpy.readthedocs.io/en/latest/_static/galpy-logo-small.gif"></a><br/> | ||
| <b>Galactic Dynamics in python</b> | ||
| </p> | ||
|
|
||
| [galpy](http://www.galpy.org) is a Python 2 and 3 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. | ||
|
|
||
| [](http://travis-ci.org/jobovy/galpy) [](https://ci.appveyor.com/project/jobovy/galpy) [](https://coveralls.io/r/jobovy/galpy?branch=master) [](http://codecov.io/github/jobovy/galpy?branch=master) [](http://docs.galpy.org/en/latest/) [](https://pypi.python.org/pypi/galpy/) [](https://anaconda.org/conda-forge/galpy) [](https://github.com/jobovy/galpy/blob/master/LICENSE) [](http://dx.doi.org/10.1088/0067-0049/216/2/29) [](http://www.astropy.org/) [](https://galpy.slack.com/) [](https://slackin-galpy.herokuapp.com) | ||
|
|
||
| AUTHOR | ||
| ====== | ||
|
|
||
| Jo Bovy - bovy at astro dot utoronto dot ca | ||
|
|
||
| See | ||
| [AUTHORS.txt](https://github.com/jobovy/galpy/blob/master/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)](http://adsabs.harvard.edu/abs/2015ApJS..216...29B) **and link to | ||
| http://github.com/jobovy/galpy**. See [the acknowledgement documentation | ||
| section](http://docs.galpy.org/en/latest/index.html#acknowledging-galpy) | ||
| for a more detailed guide to citing parts of the code. 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](http://docs.galpy.org/en/latest/) (this page is at | ||
| doc/source/index.rst). Thanks! | ||
|
|
||
| LOOKING FOR HELP? | ||
| ================= | ||
|
|
||
| The latest documentation can be found | ||
| [here](http://docs.galpy.org/en/latest/). You can also join the | ||
| [galpy slack community](https://galpy.slack.com/) for any questions | ||
| related to `galpy`; join | ||
| [here](https://slackin-galpy.herokuapp.com). | ||
|
|
||
| If you find *any* bug in the code, please report these using the [Issue | ||
| Tracker](http://github.com/jobovy/galpy/issues) or by joining the [galpy | ||
| slack community](https://galpy.slack.com/). | ||
|
|
||
| If you are having issues with the installation of `galpy`, please first | ||
| consult the [Installation | ||
| FAQ](http://docs.galpy.org/en/latest/installation.html#installation-faq). | ||
|
|
||
| PYTHON VERSIONS AND DEPENDENCIES | ||
| ================================ | ||
|
|
||
| `galpy` supports both Python 2 and 3. Specifically, galpy supports | ||
| Python 2.7 and Python 3.6 and 3.7. It should also work on earlier Python | ||
| 3.\* versions, but this is not extensively tested on an ongoing basis. | ||
| Travis CI builds regularly check support for Python 2.7 and 3.7 (and of | ||
| 3.6 using a more limited, core set of tests) and Appveyor builds | ||
| regularly check support for Python 3.7 on Windows. | ||
|
|
||
| This package requires [Numpy](https://numpy.org/), | ||
| [Scipy](http://www.scipy.org/), and | ||
| [Matplotlib](http://matplotlib.sourceforge.net/). Certain advanced | ||
| features require the GNU Scientific Library | ||
| ([GSL](http://www.gnu.org/software/gsl/)), with action calculations | ||
| requiring version 1.14 or higher. Use of `SnapshotRZPotential` and | ||
| `InterpSnapshotRZPotential` requires | ||
| [pynbody](https://github.com/pynbody/pynbody). Support for providing | ||
| inputs and getting outputs as Quantities with units is provided through | ||
| [astropy](http://www.astropy.org/). | ||
|
|
||
| CONTRIBUTING TO GALPY | ||
| ===================== | ||
|
|
||
| If you are interested in contributing to galpy\'s development, take a | ||
| look at [this brief | ||
| guide](https://github.com/jobovy/galpy/wiki/Guide-for-new-contributors) | ||
| on the wiki. This will hopefully help you get started! | ||
|
|
||
| Some further development notes can be found on the | ||
| [wiki](http://github.com/jobovy/galpy/wiki/). This includes a list of | ||
| small and larger extensions of galpy that would be useful | ||
| [here](http://github.com/jobovy/galpy/wiki/Possible-galpy-extensions) as | ||
| well as a longer-term roadmap | ||
| [here](http://github.com/jobovy/galpy/wiki/Roadmap). Please let the main | ||
| developer know if you need any help contributing! | ||
|
|
||
| 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](http://adsabs.harvard.edu/abs/1999AJ....118.1201D)). | ||
| Calculating these corrections is expensive, and a large set of | ||
| precalculated corrections can be found | ||
| [here](http://github.com/downloads/jobovy/galpy/galpy-dfcorrections.tar.gz) | ||
| \[tar.gz archive\]. Install these by downloading them and unpacking them | ||
| into the galpy/df/data directory before running the setup.py | ||
| installation. E.g.: | ||
|
|
||
| curl -O https://github.s3.amazonaws.com/downloads/jobovy/galpy/galpy-dfcorrections.tar.gz | ||
| tar xvzf galpy-dfcorrections.tar.gz -C ./galpy/df/data/ |
Oops, something went wrong.