-
Notifications
You must be signed in to change notification settings - Fork 75
Update README #456
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Update README #456
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0872de4
Update `README.md` header
technic960183 53ae726
Add badges
technic960183 1aa04d0
Update body of `README.md`
technic960183 fe8680a
Add emojis on `README.md` header
technic960183 fdd7209
Apply suggestions from code review
technic960183 0c3c614
Update header layout
technic960183 6530b5e
Change badges design
technic960183 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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> | ||
|
|
||
| [](https://github.com/gamer-project/gamer/releases) | ||
| [](https://doi.org/10.5281/zenodo.15036956) | ||
| [](https://github.com/gamer-project/gamer?tab=License-1-ov-file) | ||
ChunYen-Chen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| [](https://github.com/gamer-project/gamer/graphs/contributors) | ||
| [](https://github.com/gamer-project/gamer/pulse) | ||
hyschive marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| [](https://iopscience.iop.org/article/10.1088/0067-0049/186/2/457) | ||
technic960183 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| [](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. | ||
technic960183 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Getting Started & Documentation | ||
technic960183 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - **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. | ||
technic960183 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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): | ||
technic960183 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```bibtex | ||
| @article{schive2018gamer, | ||
| title={GAMER-2: a GPU-accelerated adaptive mesh refinement code--accuracy, performance, and scalability}, | ||
technic960183 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.