Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.14 KB

README.md

File metadata and controls

44 lines (27 loc) · 1.14 KB

Universe Render

This is a mini package for rendering the hydro simulation into awesome visualizations.

Required Python Packages: numpy, scipy, matplotlib, numpy-quaternion, numba, mpi4py

*numpy-quaternionis used in 3D rotation of the camera for interpolation of frame. You can run the without it if you don't need to interpolate the frames.

*numba and mpi4py is for acceleration.

Required System Installation: mpi environment (for multi-process support), FFmpeg with x264 (for video making)

Roadmap

  • A working prototype for rendering
  • Documentation (ongoing)
  • Example run
  • More kernels
  • GPU accelerate support

Installation

First, clone this repo to your machine

git clone [email protected]:pointeee/universe_render.git

Then, install with pip

cd universe_render
pip install -e .

This will allow you to run the code and edit it conveniently when necessary (this is common at this stage).

Usage

Please refer the documentation and the example notebooks.

Contribute to This Project

This mini project is still in its early stage; PRs and issues are welcomed!