Phantom

The Phantom Smoothed Particle Hydrodynamics code

About

Phantom is a 3D Smoothed Particle Hydrodynamics and Magnetohydrodynamics code for astrophysics. It was written and developed by Daniel Price with contributions from many others (see AUTHORS). It is designed to be a fast 3D SPH code with a low memory footprint, for production runs. It is not a code for testing algorithms (use NDSPMHD instead).

Status

Code structure

The Phantom source code is structured as follows:


`build/Makefile`	main Makefile for compiling Phantom and all utilities
`src/main`	source for main code
`src/setup`	source for Phantomsetup utility
`src/tests`	source for unit tests and the Phantom testsuite
`src/utils`	source for optional utilities and analysis

Getting help

If you need help, please try the following, in order:

Check the documentation.
If you encounter a bug, file an issue
If you want to request a feature, file an issue, using the issue tracker.
If you need help on how to use phantom, file an issue

We welcome general discussion about Phantom, Smoothed Particle Hydrodynamics, and astrophysics at the Phantom Slack. However, please use the github issues for support requests.

Contributing

We welcome contributions, including (but not limited to):

Code, via pull request. Please read developer section of user guide for guidelines.
Documentation, also by pull request. Docs can be edited in the docs/ directory of the main code.
Suggestions for features or bug reports, via the issue tracker. Please file bugs via github rather than by email.

Citation

Please cite Price et al. (2018) when using Phantom. Wherever possible, please try to also cite original references for the algorithms you are using. A partial list can be found in docs/phantom.bib file, or by reading the relevant sections of the paper.

Other things

For CHANGES see the release notes: https://phantomsph.readthedocs.io/en/latest/releasenotes.html. See LICENCE file for usage and distribution conditions.

danieljprice / phantom

readme