Skip to main content

Numerical routines for working with spherical harmonic coefficients

Project description

SpherePy

SpherePy is a package for working with scalar and vector spherical harmonics. It provides:

  • scalar and vector spherical harmonic decompositions

  • objects for algebraically manipulating harmonic coefficients

  • the ability to plot coefficients and patterns

Badges (lots of them)

AppVeyor:

[![Build status](https://ci.appveyor.com/api/projects/status/ccwuv424wao4rbly?svg=true)](https://ci.appveyor.com/project/rdireen/spherepy)

TravisCI:

[![Build Status](https://travis-ci.org/rdireen/spherepy.svg?branch=master)](https://travis-ci.org/rdireen/spherepy) [![Coverage Status](https://coveralls.io/repos/rdireen/spherepy/badge.svg?branch=master)](https://coveralls.io/r/rdireen/spherepy?branch=master)

PyPI:

[![Downloads](https://pypip.in/download/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/) [![Latest Version](https://pypip.in/version/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/) [![Supported Python versions](https://pypip.in/py_versions/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/) [![Supported Python implementations](https://pypip.in/implementation/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/)

[![Development Status](https://pypip.in/status/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/) [![Wheel Status](https://pypip.in/wheel/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/) [![Egg Status](https://pypip.in/egg/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/) [![Download format](https://pypip.in/format/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/) [![License](https://pypip.in/license/spherepy/badge.svg)](https://pypi.python.org/pypi/spherepy/)

Better Documentation

I’m working on a more complete documentation [HERE](http://www.direentech.com/docs/spherepy).

Install

pip

For Windows I use wheels to distribute the binaries, so make sure pip is up to date.

Ubuntu: Before installing SpherePy you must install build-essential, python-dev, and NumPy

$ sudo apt-get install build-essential python-dev $ sudo pip install numpy

Then you can

$ sudo pip install spherepy

Windows: Make sure you have Numpy on your machine, then

$ pip install spherepy

Plotting

If you would like to use the plotting routines within SpherePy, install matplotlib:

$ sudo pip install matplotlib

Quick Example

>>> import spherepy as sp
>>> c = sp.random_coefs(4, 4) # generate some random coefficients
>>> p = sp.ispht(c, 50, 50) # inverse spherical transform to pattern
>>> sp.plot_sphere_mag(p) # plot the magnitude of the pattern

Contributing

Reporting bugs, suggesting features, helping with documentation, and adding to the code is very welcome. See [Contributing](CONTRIBUTING.md).

License

Copyright (C) 2015 Randy Direen <spherepy@direentech.com>. SpherePy is licensed under GNU General Public License, version 3, a copy of this license has been provided within the COPYING file in this directory, and can also be found at <http://www.gnu.org/licenses/>.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spherepy-0.0.6.zip (74.5 kB view hashes)

Uploaded Source

Built Distributions

spherepy-0.0.6-cp34-none-win_amd64.whl (55.7 kB view hashes)

Uploaded CPython 3.4 Windows x86-64

spherepy-0.0.6-cp34-none-win32.whl (50.9 kB view hashes)

Uploaded CPython 3.4 Windows x86

spherepy-0.0.6-cp33-none-win_amd64.whl (55.8 kB view hashes)

Uploaded CPython 3.3 Windows x86-64

spherepy-0.0.6-cp33-none-win32.whl (50.9 kB view hashes)

Uploaded CPython 3.3 Windows x86

spherepy-0.0.6-cp27-none-win_amd64.whl (56.1 kB view hashes)

Uploaded CPython 2.7 Windows x86-64

spherepy-0.0.6-cp27-none-win32.whl (51.2 kB view hashes)

Uploaded CPython 2.7 Windows x86

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page