| 1 |
Metadata-Version: 2.1 |
| 2 |
Name: astroML |
| 3 |
Version: 1.0.2 |
| 4 |
Summary: Tools for machine learning and data mining in Astronomy |
| 5 |
Home-page: http://astroML.github.com |
| 6 |
Author: Jake VanderPlas |
| 7 |
Author-email: [email protected] |
| 8 |
Maintainer: Brigitta Sipocz |
| 9 |
Maintainer-email: [email protected] |
| 10 |
License: BSD 3-Clause License |
| 11 |
Description: .. -*- mode: rst -*- |
| 12 |
|
| 13 |
======================================= |
| 14 |
AstroML: Machine Learning for Astronomy |
| 15 |
======================================= |
| 16 |
|
| 17 |
.. image:: https://img.shields.io/badge/arXiv-1411.5039-orange.svg?style=flat |
| 18 |
:target: https://arxiv.org/abs/1411.5039 |
| 19 |
.. image:: https://img.shields.io/travis/astroML/astroML/master.svg?style=flat |
| 20 |
:target: https://travis-ci.org/astroML/astroML/ |
| 21 |
.. image:: https://img.shields.io/pypi/v/astroML.svg?style=flat |
| 22 |
:target: https://pypi.python.org/pypi/astroML |
| 23 |
.. image:: https://img.shields.io/pypi/dm/astroML.svg?style=flat |
| 24 |
:target: https://pypi.python.org/pypi/astroML |
| 25 |
.. image:: https://img.shields.io/badge/license-BSD-blue.svg?style=flat |
| 26 |
:target: https://github.com/astroml/astroml/blob/main/LICENSE.rst |
| 27 |
|
| 28 |
AstroML is a Python module for machine learning and data mining |
| 29 |
built on numpy, scipy, scikit-learn, and matplotlib, |
| 30 |
and distributed under the BSD license. |
| 31 |
It contains a growing library of statistical and machine learning |
| 32 |
routines for analyzing astronomical data in python, loaders for several open |
| 33 |
astronomical datasets, and a large suite of examples of analyzing and |
| 34 |
visualizing astronomical datasets. |
| 35 |
|
| 36 |
This project was started in 2012 by Jake VanderPlas to accompany the book |
| 37 |
*Statistics, Data Mining, and Machine Learning in Astronomy* by |
| 38 |
Zeljko Ivezic, Andrew Connolly, Jacob VanderPlas, and Alex Gray. |
| 39 |
|
| 40 |
|
| 41 |
Important Links |
| 42 |
=============== |
| 43 |
- HTML documentation: https://www.astroML.org |
| 44 |
- Core source-code repository: https://github.com/astroML/astroML |
| 45 |
- Figure source-code repository: https://github.com/astroML/astroML-figures |
| 46 |
- Issue Tracker: https://github.com/astroML/astroML/issues |
| 47 |
- Mailing List: https://groups.google.com/forum/#!forum/astroml-general |
| 48 |
|
| 49 |
|
| 50 |
Installation |
| 51 |
============ |
| 52 |
|
| 53 |
**Before installation, make sure your system meets the prerequisites |
| 54 |
listed in Dependencies, listed below.** |
| 55 |
|
| 56 |
Core |
| 57 |
---- |
| 58 |
To install the core ``astroML`` package in your home directory, use:: |
| 59 |
|
| 60 |
pip install astroML |
| 61 |
|
| 62 |
A conda package for astroML is also available either on the conda-forge or |
| 63 |
on the astropy conda channels:: |
| 64 |
|
| 65 |
conda install -c astropy astroML |
| 66 |
|
| 67 |
The core package is pure python, so installation should be straightforward |
| 68 |
on most systems. To install from source, use:: |
| 69 |
|
| 70 |
python setup.py install |
| 71 |
|
| 72 |
You can specify an arbitrary directory for installation using:: |
| 73 |
|
| 74 |
python setup.py install --prefix='/some/path' |
| 75 |
|
| 76 |
To install system-wide on Linux/Unix systems:: |
| 77 |
|
| 78 |
python setup.py build |
| 79 |
sudo python setup.py install |
| 80 |
|
| 81 |
|
| 82 |
Dependencies |
| 83 |
============ |
| 84 |
There are two levels of dependencies in astroML. *Core* dependencies are |
| 85 |
required for the core ``astroML`` package. *Optional* dependencies are required |
| 86 |
to run some (but not all) of the example scripts. Individual example scripts |
| 87 |
will list their optional dependencies at the top of the file. |
| 88 |
|
| 89 |
Core Dependencies |
| 90 |
----------------- |
| 91 |
The core ``astroML`` package requires the following (some of the |
| 92 |
functionality might work with older versions): |
| 93 |
|
| 94 |
- Python_ version 3.6+ |
| 95 |
- Numpy_ >= 1.13 |
| 96 |
- Scipy_ >= 0.18 |
| 97 |
- Scikit-learn_ >= 0.18 |
| 98 |
- Matplotlib_ >= 3.0 |
| 99 |
- AstroPy_ >= 3.0 |
| 100 |
|
| 101 |
Optional Dependencies |
| 102 |
--------------------- |
| 103 |
Several of the example scripts require specialized or upgraded packages. |
| 104 |
These requirements are listed at the top of the particular scripts |
| 105 |
|
| 106 |
- HEALPy_ provides an interface to |
| 107 |
the HEALPix pixelization scheme, as well as fast spherical harmonic |
| 108 |
transforms. |
| 109 |
|
| 110 |
Development |
| 111 |
=========== |
| 112 |
This package is designed to be a repository for well-written astronomy code, |
| 113 |
and submissions of new routines are encouraged. After installing the |
| 114 |
version-control system Git_, you can check out |
| 115 |
the latest sources from GitHub_ using:: |
| 116 |
|
| 117 |
git clone git://github.com/astroML/astroML.git |
| 118 |
|
| 119 |
or if you have write privileges:: |
| 120 |
|
| 121 |
git clone [email protected]:astroML/astroML.git |
| 122 |
|
| 123 |
Contribution |
| 124 |
------------ |
| 125 |
We strongly encourage contributions of useful astronomy-related code: |
| 126 |
for `astroML` to be a relevant tool for the python/astronomy community, |
| 127 |
it will need to grow with the field of research. There are a few |
| 128 |
guidelines for contribution: |
| 129 |
|
| 130 |
General |
| 131 |
~~~~~~~ |
| 132 |
Any contribution should be done through the github pull request system (for |
| 133 |
more information, see the |
| 134 |
`help page <https://help.github.com/articles/using-pull-requests>`_ |
| 135 |
Code submitted to ``astroML`` should conform to a BSD-style license, |
| 136 |
and follow the `PEP8 style guide <http://www.python.org/dev/peps/pep-0008/>`_. |
| 137 |
|
| 138 |
Documentation and Examples |
| 139 |
~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 140 |
All submitted code should be documented following the |
| 141 |
`Numpy Documentation Guide`_. This is a unified documentation style used |
| 142 |
by many packages in the scipy universe. |
| 143 |
|
| 144 |
In addition, it is highly recommended to create example scripts that show the |
| 145 |
usefulness of the method on an astronomical dataset (preferably making use |
| 146 |
of the loaders in ``astroML.datasets``). These example scripts are in the |
| 147 |
``examples`` subdirectory of the main source repository. |
| 148 |
|
| 149 |
.. _Numpy Documentation Guide: https://numpydoc.readthedocs.io/en/latest/format.html |
| 150 |
|
| 151 |
Authors |
| 152 |
======= |
| 153 |
|
| 154 |
Package Author |
| 155 |
-------------- |
| 156 |
* Jake Vanderplas https://github.com/jakevdp |
| 157 |
http://jakevdp.github.com |
| 158 |
|
| 159 |
Maintainer |
| 160 |
---------- |
| 161 |
* Brigitta Sipocz https://github.com/bsipocz |
| 162 |
|
| 163 |
Code Contribution |
| 164 |
----------------- |
| 165 |
* Morgan Fouesneau https://github.com/mfouesneau |
| 166 |
* Julian Taylor http://github.com/juliantaylor |
| 167 |
|
| 168 |
|
| 169 |
.. _Python: https://www.python.org |
| 170 |
.. _Numpy: https://www.numpy.org |
| 171 |
.. _Scipy: https://www.scipy.org |
| 172 |
.. _Scikit-learn: https://scikit-learn.org |
| 173 |
.. _Matplotlib: https://matplotlib.org |
| 174 |
.. _AstroPy: http://www.astropy.org/ |
| 175 |
.. _HEALPy: https://github.com/healpy/healpy |
| 176 |
.. _Git: https://git-scm.com/ |
| 177 |
.. _GitHub: https://www.github.com |
| 178 |
|
| 179 |
Keywords: astronomy,astrophysics,cosmology,space,science,modeling,models,fitting,machine-learning |
| 180 |
Platform: UNKNOWN |
| 181 |
Classifier: Development Status :: 4 - Beta |
| 182 |
Classifier: Environment :: Console |
| 183 |
Classifier: Intended Audience :: Science/Research |
| 184 |
Classifier: License :: OSI Approved :: BSD License |
| 185 |
Classifier: Natural Language :: English |
| 186 |
Classifier: Programming Language :: Python :: 3 |
| 187 |
Classifier: Programming Language :: Python :: 3.5 |
| 188 |
Classifier: Programming Language :: Python :: 3.6 |
| 189 |
Classifier: Programming Language :: Python :: 3.7 |
| 190 |
Classifier: Programming Language :: Python :: 3.8 |
| 191 |
Classifier: Programming Language :: Python :: 3 :: Only |
| 192 |
Classifier: Topic :: Scientific/Engineering :: Astronomy |
| 193 |
Provides-Extra: test |
| 194 |
Provides-Extra: all |
| 195 |
Provides-Extra: codestyle |
| 196 |
Provides-Extra: docs |