Metadata-Version: 1.0
Name: PySpace
Version: 0.0.2
Summary: A toolbox for galactic simulations.
Home-page: https://github.com/adityapb/pyspace
Author: PySpace developers
Author-email: adityapb1546@gmail.com
License: UNKNOWN
Description: PySpace
        =======
        
        | **A python-based toolbox for galactic simulations**
        |
        | |Build Status| |Docs Status|
        
        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.
        -  Dumps vtk output which allows users to take advantage of tools like
           ParaView, MayaVi, etc. for visualization.
        
        Algorithms
        ----------
        
        -  Brute Force :math:`O(n^2)`
        
        Installation
        ------------
        
        Dependencies
        ~~~~~~~~~~~~
        
        -  Numpy
        -  PyEVTK (``pip install pyevtk``)
        -  gcc compiler
        -  OpenMP (optional)
        -  ParaView / MayaVi or any other vtk rendering tool (optional)
        
        Linux and OSX
        ~~~~~~~~~~~~~
        
        | Clone this repository by
          ``git clone https://github.com/adityapb/pyspace.git``
        | Run ``python setup.py install`` to install.
        |
        | **PySpace doesn't support Windows currently**
        
        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
        
Platform: UNKNOWN
