Commit f3289159 authored by Ole Streicher's avatar Ole Streicher

Initial upstream version 0.6.1

parents
This diff is collapsed.
Metadata-Version: 1.1
Name: sunpy
Version: 0.6.1
Summary: SunPy: Python for Solar Physics
Home-page: http://sunpy.org/
Author: The SunPy Community
Author-email: sunpy@googlegroups.com
License: BSD
Description: SunPy is a Python library for solar physics data analysis.
Platform: UNKNOWN
Provides: sunpy
# [SunPy](http://sunpy.org)
[![Downloads](https://pypip.in/d/sunpy/badge.png)](https://pypi.python.org/pypi/sunpy/) [![Latest Version](https://pypip.in/v/sunpy/badge.png)](https://pypi.python.org/pypi/sunpy/) [![Build Status](https://secure.travis-ci.org/sunpy/sunpy.png)] (http://travis-ci.org/sunpy/sunpy)[![Build status](https://ci.appveyor.com/api/projects/status/xow461iejsjvp9vl?svg=true)](https://ci.appveyor.com/project/sunpy/sunpy)[![Coverage Status](https://coveralls.io/repos/sunpy/sunpy/badge.png?branch=master)](https://coveralls.io/r/sunpy/sunpy?branch=master) [![Code Health](https://landscape.io/github/sunpy/sunpy/master/landscape.png)](https://landscape.io/github/sunpy/sunpy/master)
SunPy is an open-source Python library for solar physics data analysis.
Installation
------------
To begin, install the following requirements:
* [Python](http://www.python.org) (2.7+)
* [Astropy](http://astropy.org) (1.0.0)
* [NumPy](http://numpy.scipy.org/)
* [SciPy](http://www.scipy.org/)
* [Matplotlib](http://matplotlib.sourceforge.net/) (1.1+)
* [Suds](https://fedorahosted.org/suds)
* [pandas](http://pandas.pydata.org/) (0.10.0+)
* [beautifulsoup4](http://www.crummy.com/software/BeautifulSoup/)
* [sqlalchemy](http://www.sqlalchemy.org/)
Next, use git to grab the latest version of SunPy:
git clone https://github.com/sunpy/sunpy.git
cd sunpy
python setup.py install
Done!
For detailed installation instructions, see the [installation guide](http://sunpy.readthedocs.org/en/latest/guide/installation/index.html)
in the SunPy docs.
Usage
-----
Here is a quick example of plotting an AIA image:
```python
>>> import sunpy.map
>>> import sunpy.data.sample
>>> import matplotlib.cm as cm
>>> aia = sunpy.map.Map(sunpy.data.sample.AIA_171_IMAGE)
>>> aia.peek(cmap=cm.hot)
```
Getting Help
------------
For more information or to ask questions about SunPy, check out:
* [SunPy Documentation](http://sunpy.readthedocs.org/en/latest/)
* [SunPy Mailing List](https://groups.google.com/forum/#!forum/sunpy)
* IRC: #sunpy on [freenode.net](http://webchat.freenode.net/)
Contributing
------------
If you would like to get involved, start by joining the
[SunPy mailing list](https://groups.google.com/forum/#!forum/sunpy)
and check out the [Developer's Guide](http://sunpy.readthedocs.org/en/latest/dev.html) section
of the SunPy docs. Stop by our IRC chat room named #sunpy on irc.freenode.net
if you have any questions. Help is always welcome so let us know what you like
to work on, or check out the [issues page](https://github.com/sunpy/sunpy/issues)
for a list of some known outstanding items.
The SunPy project is happy to announce the release of SunPy 0.6.0.
This is a major SunPy release with lots of changes that will make SunPy even
better than it was before.
This release consists of 1,341 commits from 29 different people and
13 new contributors!
The major changes in this release are:
* Most functions throughout the SunPy code base expect Astropy
Quantity objects, and return Astropy Quantity objects.
* Python 2.6 support has ended, we do not expect this release to
work under Python 2.6.
* Sample data has been removed from SunPy but helpers for
downloading sample data have been added to sunpy.data.
* TimeRange has a new property based API, e.g. start and end are
now properties.
* Map.rotate() now pads arrays to prevent loss of data under
rotation.
* Map.rotate() now defaults to the slower but more accurate
bi-quartic interpolation method (order=4).
* SunPy colormaps are now registered with matplotlib, allowing
their use from imshow and similar functions after the import
of sunpy.cm.
* JSOC client export calls now checks for an email address.
* Solar rotation calculation functionality has been added, along
with functionality to de-rotate MapCubes.
* Files downloaded through the VSO now keep their file
extension.
The people who have contributed to this release are:
Stuart Mumford
Daniel Ryan
Steven Christe
Jack Ireland
Brigitta Sipocz *
Asish Panda
Andrew Inglis
Albert Y. Shih
Rishabh Sharma
David Perez-Suarez
Rajul Srivastava
Andrew Leonard
Ruben De Visscher *
Dumindu Buddhika *
Goran Cetusic *
Jongyeob Park *
Chloé Guennou *
Ishtyaq Habib *
Nabil Freij
Simon Liedtke
Abigail Stevens *
Alex Hamilton *
Ambar Mehrotra *
Erik M. Bray *
Jaylen Wimbish *
Juan Camilo Buitrago-Casas *
Larry Manley
Norbert Gyenge
Rishabh Mishra *
Where an * indicates their first contribution.
This diff is collapsed.
astropy-helpers Changelog
=========================
1.0.3 (2015-07-22)
------------------
- Added workaround for sphinx-doc/sphinx#1843, a but in Sphinx which
prevented descriptor classes with a custom metaclass from being documented
correctly. [#158]
- Added an alias for the ``./setup.py build_sphinx`` command as
``./setup.py build_docs`` which, to a new contributor, should hopefully be
less cryptic. [#161]
- The fonts in graphviz diagrams now match the font of the HTML content. [#169]
- When the documentation is built on readthedocs.org, MathJax will be
used for math rendering. When built elsewhere, the "pngmath"
extension is still used for math rendering. [#170]
- Fix crash when importing astropy_helpers when running with ``python -OO``
[#171]
- The ``build`` and ``build_ext`` stages now correctly recognize the presence
of C++ files in Cython extensions (previously only vanilla C worked). [#173]
1.0.2 (2015-04-02)
------------------
- Various fixes enabling the astropy-helpers Sphinx build command and
Sphinx extensions to work with Sphinx 1.3. [#148]
- More improvement to the ability to handle multiple versions of
astropy-helpers being imported in the same Python interpreter session
in the (somewhat rare) case of nested installs. [#147]
- To better support high resolution displays, use SVG for the astropy
logo and linkout image, falling back to PNGs for browsers that
support it. [#150, #151]
- Improve ``setup_helpers.get_compiler_version`` to work with more compilers,
and to return more info. This will help fix builds of Astropy on less
common compilers, like Sun C. [#153]
1.0.1 (2015-03-04)
------------------
- Released in concert with v0.4.8 to address the same issues.
- Improved the ``ah_bootstrap`` script's ability to override existing
installations of astropy-helpers with new versions in the context of
installing multiple packages simultaneously within the same Python
interpreter (e.g. when one package has in its ``setup_requires`` another
package that uses a different version of astropy-helpers. [#144]
- Added a workaround to an issue in matplotlib that can, in rare cases, lead
to a crash when installing packages that import matplotlib at build time.
[#144]
0.4.8 (2015-03-04)
------------------
- Improved the ``ah_bootstrap`` script's ability to override existing
installations of astropy-helpers with new versions in the context of
installing multiple packages simultaneously within the same Python
interpreter (e.g. when one package has in its ``setup_requires`` another
package that uses a different version of astropy-helpers. [#144]
- Added a workaround to an issue in matplotlib that can, in rare cases, lead
to a crash when installing packages that import matplotlib at build time.
[#144]
1.0 (2015-02-17)
----------------
- Added new pre-/post-command hook points for ``setup.py`` commands. Now any
package can define code to run before and/or after any ``setup.py`` command
without having to manually subclass that command by adding
``pre_<command_name>_hook`` and ``post_<command_name>_hook`` callables to
the package's ``setup_package.py`` module. See the PR for more details.
[#112]
- The following objects in the ``astropy_helpers.setup_helpers`` module have
been relocated:
- ``get_dummy_distribution``, ``get_distutils_*``, ``get_compiler_option``,
``add_command_option``, ``is_distutils_display_option`` ->
``astropy_helpers.distutils_helpers``
- ``should_build_with_cython``, ``generate_build_ext_command`` ->
``astropy_helpers.commands.build_ext``
- ``AstropyBuildPy`` -> ``astropy_helpers.commands.build_py``
- ``AstropyBuildSphinx`` -> ``astropy_helpers.commands.build_sphinx``
- ``AstropyInstall`` -> ``astropy_helpers.commands.install``
- ``AstropyInstallLib`` -> ``astropy_helpers.commands.install_lib``
- ``AstropyRegister`` -> ``astropy_helpers.commands.register``
- ``get_pkg_version_module`` -> ``astropy_helpers.version_helpers``
- ``write_if_different``, ``import_file``, ``get_numpy_include_path`` ->
``astropy_helpers.utils``
All of these are "soft" deprecations in the sense that they are still
importable from ``astropy_helpers.setup_helpers`` for now, and there is
no (easy) way to produce deprecation warnings when importing these objects
from ``setup_helpers`` rather than directly from the modules they are
defined in. But please consider updating any imports to these objects.
[#110]
- Use of the ``astropy.sphinx.ext.astropyautosummary`` extension is deprecated
for use with Sphinx < 1.2. Instead it should suffice to remove this
extension for the ``extensions`` list in your ``conf.py`` and add the stock
``sphinx.ext.autosummary`` instead. [#131]
0.4.7 (2015-02-17)
------------------
- Fixed incorrect/missing git hash being added to the generated ``version.py``
when creating a release. [#141]
0.4.6 (2015-02-16)
------------------
- Fixed problems related to the automatically generated _compiler
module not being created properly. [#139]
0.4.5 (2015-02-11)
------------------
- Fixed an issue where ah_bootstrap.py could blow up when astropy_helper's
version number is 1.0.
- Added a workaround for documentation of properties in the rare case
where the class's metaclass has a property of the same name. [#130]
- Fixed an issue on Python 3 where importing a package using astropy-helper's
generated version.py module would crash when the current working directory
is an empty git repository. [#114]
- Fixed an issue where the "revision count" appended to .dev versions by
the generated version.py did not accurately reflect the revision count for
the package it belongs to, and could be invalid if the current working
directory is an unrelated git repository. [#107]
- Likewise, fixed a confusing warning message that could occur in the same
circumstances as the above issue. [#121]
0.4.4 (2014-12-31)
------------------
- More improvements for building the documentation using Python 3.x. [#100]
- Additional minor fixes to Python 3 support. [#115]
- Updates to support new test features in Astropy [#92, #106]
0.4.3 (2014-10-22)
------------------
- The generated ``version.py`` file now preserves the git hash of installed
copies of the package as well as when building a source distribution. That
is, the git hash of the changeset that was installed/released is preserved.
[#87]
- In smart resolver add resolution for class links when they exist in the
intersphinx inventory, but not the mapping of the current package
(e.g. when an affiliated package uses an astropy core class of which
"actual" and "documented" location differs) [#88]
- Fixed a bug that could occur when running ``setup.py`` for the first time
in a repository that uses astropy-helpers as a submodule:
``AttributeError: 'NoneType' object has no attribute 'mkdtemp'`` [#89]
- Fixed a bug where optional arguments to the ``doctest-skip`` Sphinx
directive were sometimes being left in the generated documentation output.
[#90]
- Improved support for building the documentation using Python 3.x. [#96]
- Avoid error message if .git directory is not present. [#91]
0.4.2 (2014-08-09)
------------------
- Fixed some CSS issues in generated API docs. [#69]
- Fixed the warning message that could be displayed when generating a
version number with some older versions of git. [#77]
- Fixed automodsumm to work with new versions of Sphinx (>= 1.2.2). [#80]
0.4.1 (2014-08-08)
------------------
- Fixed git revision count on systems with git versions older than v1.7.2.
[#70]
- Fixed display of warning text when running a git command fails (previously
the output of stderr was not being decoded properly). [#70]
- The ``--offline`` flag to ``setup.py`` understood by ``ah_bootstrap.py``
now also prevents git from going online to fetch submodule updates. [#67]
- The Sphinx extension for converting issue numbers to links in the changelog
now supports working on arbitrary pages via a new ``conf.py`` setting:
``changelog_links_docpattern``. By default it affects the ``changelog``
and ``whatsnew`` pages in one's Sphinx docs. [#61]
- Fixed crash that could result from users with missing/misconfigured
locale settings. [#58]
- The font used for code examples in the docs is now the
system-defined ``monospace`` font, rather than ``Minaco``, which is
not available on all platforms. [#50]
0.4 (2014-07-15)
----------------
- Initial release of astropy-helpers. See `APE4
<https://github.com/astropy/astropy-APEs/blob/master/APE4.rst>`_ for
details of the motivation and design of this package.
- The ``astropy_helpers`` package replaces the following modules in the
``astropy`` package:
- ``astropy.setup_helpers`` -> ``astropy_helpers.setup_helpers``
- ``astropy.version_helpers`` -> ``astropy_helpers.version_helpers``
- ``astropy.sphinx`` - > ``astropy_helpers.sphinx``
These modules should be considered deprecated in ``astropy``, and any new,
non-critical changes to those modules will be made in ``astropy_helpers``
instead. Affiliated packages wishing to make use those modules (as in the
Astropy package-template) should use the versions from ``astropy_helpers``
instead, and include the ``ah_bootstrap.py`` script in their project, for
bootstrapping the ``astropy_helpers`` package in their setup.py script.
Contributing to astropy-helpers
===============================
The guidelines for contributing to ``astropy-helpers`` are generally the same
as the [contributing guidelines for the astropy core
package](http://github.com/astropy/astropy/blob/master/CONTRIBUTING.md).
Basically, report relevant issues in the ``astropy-helpers`` issue tracker, and
we welcome pull requests that broadly follow the [Astropy coding
guidelines](http://docs.astropy.org/en/latest/development/codeguide.html).
The key subtlety lies in understanding the relationship between ``astropy`` and
``astropy-helpers``. This package contains the build, installation, and
documentation tools used by astropy. It also includes support for the
``setup.py test`` command, though Astropy is still required for this to
function (it does not currently include the full Astropy test runner). So
issues or improvements to that functionality should be addressed in this
package. Any other aspect of the [astropy core
package](http://github.com/astropy/astropy) (or any other package that uses
``astropy-helpers``) should be addressed in the github repository for that
package.
Copyright (c) 2014, Astropy Developers
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* Neither the name of the Astropy Team nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
include README.rst
include CHANGES.rst
include LICENSE.rst
include ez_setup.py
include ah_bootstrap.py
exclude *.pyc *.o
prune build
prune astropy_helpers/tests
astropy-helpers
===============
This project provides a Python package, ``astropy_helpers``, which includes
many build, installation, and documentation-related tools used by the Astropy
project, but packaged separately for use by other projects that wish to
leverage this work. The motivation behind this package and details of its
implementation are in the accepted
`Astropy Proposal for Enhancement (APE) 4 <https://github.com/astropy/astropy-APEs/blob/master/APE4.rst>`_.
``astropy_helpers`` includes a special "bootstrap" module called
``ah_bootstrap.py`` which is intended to be used by a project's setup.py in
order to ensure that the ``astropy_helpers`` package is available for
build/installation. This is similar to the ``ez_setup.py`` module that is
shipped with some projects to bootstrap `setuptools
<https://bitbucket.org/pypa/setuptools>`_.
As described in APE4, the version numbers for ``astropy_helpers`` follow the
corresponding major/minor version of the `astropy core package
<http://www.astropy.org/>`_, but with an independent sequence of micro (bugfix)
version numbers. Hence, the initial release is 0.4, in parallel with Astropy
v0.4, which will be the first version of Astropy to use ``astropy-helpers``.
For examples of how to implement ``astropy-helpers`` in a project,
see the ``setup.py`` and ``setup.cfg`` files of the
`Affiliated package template <https://github.com/astropy/package-template>`_.
.. image:: https://travis-ci.org/astropy/astropy-helpers.png
:target: https://travis-ci.org/astropy/astropy-helpers
.. image:: https://coveralls.io/repos/astropy/astropy-helpers/badge.png
:target: https://coveralls.io/r/astropy/astropy-helpers
This diff is collapsed.
# AppVeyor.com is a Continuous Integration service to build and run tests under
# Windows
environment:
global:
PYTHON: "C:\\conda"
MINICONDA_VERSION: "3.5.5"
CMD_IN_ENV: "cmd /E:ON /V:ON /C .\\continuous-integration\\appveyor\\windows_sdk.cmd"
PYTHON_ARCH: "64" # needs to be set for CMD_IN_ENV to succeed. If a mix
# of 32 bit and 64 bit builds are needed, move this
# to the matrix section.
matrix:
- PYTHON_VERSION: "2.6"
- PYTHON_VERSION: "2.7"
- PYTHON_VERSION: "3.4"
platform:
-x64
install:
# Install miniconda using a powershell script.
- "powershell continuous-integration/appveyor/install-miniconda.ps1"
- "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
# Install the build and runtime dependencies of the project.
- "conda update --yes conda"
# Create a conda environment
- "conda create -q --yes -n test python=%PYTHON_VERSION%"
- "activate test"
# Check that we have the expected version of Python
-