License
AMReX Copyright (c) 2017, The Regents of the University of California,
through Lawrence Berkeley National Laboratory and the Alliance for
Sustainable Energy, LLC., through National Renewable Energy Laboratory
(subject to receipt of any required approvals from the U.S. Dept. of
Energy). All rights reserved.
If you have questions about your rights to use or distribute this
software, please contact Berkeley Lab's Innovation & Partnerships
Office at IPO@lbl.gov.
NOTICE. This Software was developed under funding from the
U.S. Department of Energy and the U.S. Government consequently retains
certain rights. As such, the U.S. Government has been granted for
itself and others acting on its behalf a paid-up, nonexclusive,
irrevocable, worldwide license in the Software to reproduce,
distribute copies to the public, prepare derivative works, and perform
publicly and display publicly, and to permit other to do so.
License for AMReX can be found at LICENSE.
Development Model
Development generally follows the following ideas:
-
New features are committed to the
developmentbranch.Nightly regression testing is used to ensure that no answers
change (or if they do, that the changes were expected).If a change is critical, we can cherry-pick the commit from
developmenttomaster. -
Bug fixes, questions and contributions of new features are welcome!
-
Bugs should be reported through GitHub issues
-
We suggest asking questions through GitHub issues as well
-
Any contributions of new features that have the potential
to change answers should be done via pull requests.
A pull request should be generated from your fork of
amrex and target thedevelopmentbranch.If there are a number of small commits making up the PR, we may
wish to squash commits upon merge to have a clean history.
Please ensure that your PR title and first post are descriptive,
since these will be used for a squashed commit message.Please note the following:
If you choose to make contributions to the code
then you hereby grant a non-exclusive, royalty-free perpetual license
to install, use, modify, prepare derivative works,
incorporate into other computer software,
distribute, and sublicense such enhancements or derivative works
thereof, in binary and source code form.
-
-
On the first workday of each month, we perform a merge of
developmentintomaster. For this merge to take place, we
need to be passing the regression tests.To accommodate this need, we close the merge window into
developmenta few days before the merge day. While the merge
window is closed, only bug fixes should be pushed into
development. Once the merge fromdevelopment->masteris
done, the merge window reopens.
Core Developers
People who make a number of substantive contributions will be named
"core developers" of AMReX. The criteria for becoming a core
developer are flexible, but generally involve one of the following:
-
100 non-trivial commits to
amrex/Src/and/or -
addition of a new algorithm / module and/or
-
substantial input into the code design process or testing
If a core developer is inactive for multiple years, we may reassess their
status as a core developer.
The current list of core developers is: Ann Almgren (LBNL), Vince Beckner, John Bell (LBNL), Johannes Blaschke (LBNL), Cy Chan (LBNL), Marcus Day (LBNL), Brian Friesen (NERSC), Kevin Gott (NERSC), Daniel Graves (LBNL), Max Katz (NVIDIA), Andrew Myers (LBNL), Tan Nguyen (LBNL), Andrew Nonaka (LBNL), Michele Rosso (LBNL), Sam Williams (LBNL), Weiqun Zhang (LBNL), Michael Zingale (Stonybrook University).
Citation
To cite AMReX, please use
@article{AMReX_JOSS,
doi = {10.21105/joss.01370},
url = {https://doi.org/10.21105/joss.01370},
year = {2019},
month = may,
publisher = {The Open Journal},
volume = {4},
number = {37},
pages = {1370},
author = {Weiqun Zhang and Ann Almgren and Vince Beckner and John Bell and Johannes Blaschke and Cy Chan and Marcus Day and Brian Friesen and Kevin Gott and Daniel Graves and Max Katz and Andrew Myers and Tan Nguyen and Andrew Nonaka and Michele Rosso and Samuel Williams and Michael Zingale},
title = {{AMReX}: a framework for block-structured adaptive mesh refinement},
journal = {Journal of Open Source Software}
}