Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 37 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,38 @@
# GAMER
A GPU-accelerated adaptive mesh refinement code for astrophysics
<h1 align="left">
🎮&nbsp;<a href="">GAMER</a>:<br>
👾&nbsp;<a href="">G</a>PU-accelerated <a href="">A</a>daptive <a href="">ME</a>sh <a href="">R</a>efinement
</h1>

[![GitHub Release](https://img.shields.io/github/v/release/gamer-project/gamer)](https://github.com/gamer-project/gamer/releases)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15036956.svg)](https://doi.org/10.5281/zenodo.15036956)
[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://github.com/gamer-project/gamer?tab=License-1-ov-file)
[![GitHub contributors](https://img.shields.io/github/contributors/gamer-project/gamer)](https://github.com/gamer-project/gamer/graphs/contributors)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/m/gamer-project/gamer?color=brightgreen)](https://github.com/gamer-project/gamer/pulse)
[![Endpoint Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgamer-project%2Fgamer-metrics%2Frefs%2Fheads%2Fcitation%2Fcitations%2Fgamer1citation.json&color=brightgreen)](https://iopscience.iop.org/article/10.1088/0067-0049/186/2/457)
[![Endpoint Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgamer-project%2Fgamer-metrics%2Frefs%2Fheads%2Fcitation%2Fcitations%2Fgamer2citation.json&color=brightgreen)](https://academic.oup.com/mnras/article/481/4/4815/5106358)

**GAMER** is a **G**PU-accelerated **A**daptive **ME**sh **R**efinement code for astrophysical simulations. It delivers high computational performance and supports a rich set of physics modules.

## Getting Started

- [**Quick Start**](https://github.com/gamer-project/gamer/wiki/Quick-Start): Step-by-step guide to quickly set up and run GAMER.
- [**Installation Guide**](https://github.com/gamer-project/gamer/wiki/Installation): Detailed instructions for installing GAMER on various platforms.
- [**Full Documentation**](https://github.com/gamer-project/gamer/wiki): Comprehensive user guide covering usage, configuration, physics modules, and advanced features.

## Citation

To cite GAMER in your publication, please use the following BibTeX entry to refer to the [code paper](https://academic.oup.com/mnras/article/481/4/4815/5106358):

```bibtex
@article{schive2018gamer,
title="{GAMER-2: a GPU-accelerated adaptive mesh refinement code -- accuracy, performance, and scalability}",
author={Schive, Hsi-Yu and ZuHone, John A and Goldbaum, Nathan J and Turk, Matthew J and Gaspari, Massimo and Cheng, Chin-Yu},
journal={Monthly Notices of the Royal Astronomical Society},
volume={481},
number={4},
pages={4815--4840},
year={2018},
publisher={Oxford University Press}
}
```

Documentation: [wiki](https://github.com/gamer-project/gamer/wiki)
Loading