Skip to content
Merged
Changes from 4 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
44 changes: 41 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,42 @@
# GAMER
A GPU-accelerated adaptive mesh refinement code for astrophysics
<h1 align="center">
🎮🖥️ <a href="">GAMER</a>: A <a href="">G</a>PU-accelerated 🌌👾<br>
<a href="">A</a>daptive <a href="">ME</a>sh <a href="">R</a>efinement code for astrophysics
</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)](https://github.com/gamer-project/gamer/pulse)
[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.crossref.org%2Fworks%2F10.1088%2F0067-0049%2F186%2F2%2F457&query=%24.message.is-referenced-by-count&label=GAMER-1%20Citations)](https://iopscience.iop.org/article/10.1088/0067-0049/186/2/457)
[![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.crossref.org%2Fworks%2F10.1093%2Fmnras%2Fsty2586&query=%24.message.is-referenced-by-count&label=GAMER-2%20Citations)](https://academic.oup.com/mnras/article/481/4/4815/5106358)

**GAMER** is a **G**PU-accelerated **A**daptive **ME**sh **R**efinement code that features
high performance, strong parallel scalability, and a wide range of physics modules.

## Getting Started & Documentation

- **Quick Start Guide**: [Quick Start](https://github.com/gamer-project/gamer/wiki/Quick-Start)
A step-by-step guide to quickly set up and run GAMER.
- **Installation Instructions**: [Installation](https://github.com/gamer-project/gamer/wiki/Installation)
Detailed instructions for installing GAMER on various platforms.
- **Comprehensive Documentation**: [Wiki](https://github.com/gamer-project/gamer/wiki)
Full documentation covering all aspects of GAMER, including usage, configuration, and advanced features.

## Citation

To cite GAMER in your research, please use the following BibTeX entry to reference 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)