Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A toolbox for galactic simulations.

Project description

=======
PySpace
=======

| **A python-based toolbox for galactic simulations**
|
| |Build Status| |Docs Status| |Coverage|
|

.. figure:: docs/source/screenshots/galaxy_collision.jpg
:scale: 70 %

Galaxy collision simulation done using PySpace

Documentation
=============

The documentation for this project can be found at `http://pyspace.readthedocs.org/ <http://pyspace.readthedocs.org/>`_.

Features
========

- A python interface for high performance C++ implementation of N-body
simulation algorithms.
- PySpace has a numpy friendly API which makes it easier to use.
- Parallel support using OpenMP.
- GPU support using CUDA
- Dumps vtk output which allows users to take advantage of tools like
ParaView, MayaVi, etc. for visualization.

Algorithms
==========

- Brute Force :math:`O(n^2)`
- Barnes-Hut :math:`O(nlogn)`

Installation
============

Dependencies
------------

- Numpy
- PyEVTK (``pip install pyevtk``)
- gcc compiler
- OpenMP (optional)
- ParaView / MayaVi or any other vtk rendering tool (optional)

Linux and OSX
-------------

To install the latest stable version, run::

$ pip install pyspace

To install development version, clone this repository by::

$ git clone https://github.com/adityapb/pyspace.git

To install, run::

$ python setup.py install

To install without OpenMP, set ``USE_OPENMP`` environment variable
to 0 and then install::

$ export USE_OPENMP=0
$ python setup.py install

To install without GPU support, set ``USE_CUDA`` environment variable
to 0 and then install::

$ export USE_CUDA=0
$ python setup.py install

Troubleshooting
---------------

If you run into any issues regarding installation or otherwise, please report
`here <https://github.com/adityapb/pyspace/issues>`_.

Some common issues are addressed below

CUDA not found
~~~~~~~~~~~~~~

Make sure if the CUDA toolkit is installed. If you still get this message after installation,
follow the instructions given below.

Add CUDA it to ``PATH`` environmental variable and try again

Or, set ``CUDAHOME`` environmental variable to path of the CUDA installation by::

$ export CUDAHOME=/usr/local/cuda

Image not found
~~~~~~~~~~~~~~~

If your code compiles and you get this error at runtime, make sure you have a CUDA
compatible device installed.

If you don't, install without GPU support (see Installation)

**PySpace doesn't support Windows currently**

Running the tests
=================

For running the tests you will need to install ``nose``, install using::

$ pip install nose

To run the tests, from project's root directory run::

$ make test

Running the benchmarks
======================

For running benchmarks you will need to install ``pandas``, install using::

$ pip install pandas

To run the benchmarks, cd to benchmarks directory and run::

$ python run_benchmarks.py

Contributing
============

Use PEP 8 coding standard for python and follow
`this <https://users.ece.cmu.edu/~eno/coding/CppCodingStandard.html>`__
for C++.

.. |Build Status| image:: https://travis-ci.org/adityapb/pyspace.svg?branch=master
:target: https://travis-ci.org/adityapb/pyspace

.. |Docs Status| image:: https://readthedocs.org/projects/pyspace/badge/?version=stable
:target: http://pyspace.readthedocs.org/en/stable/?badge=stable
:alt: Documentation Status

.. |Coverage| image:: https://coveralls.io/repos/github/adityapb/pyspace/badge.svg?branch=master
:target: https://coveralls.io/github/adityapb/pyspace?branch=master

Project details


Download files

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

Files for PySpace, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size PySpace-0.1.0.tar.gz (36.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page