diff --git a/NOTICE b/NOTICE new file mode 100644 index 000000000..b683ef71a --- /dev/null +++ b/NOTICE @@ -0,0 +1,4 @@ +GACODE +Copyright (c) 2003-2024 General Atomics + +This product contains software and algorithms developed at General Atomics by the Theory and Computational Science group. The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work. \ No newline at end of file diff --git a/NOTICE.md b/NOTICE.md deleted file mode 100644 index 0f3f8c7b1..000000000 --- a/NOTICE.md +++ /dev/null @@ -1,19 +0,0 @@ -# GACODE Notice - -The purpose of this NOTICE file is to provide legal notices and acknowledgments that must be displayed to users in any derivative works or distributions. This file does not alter the terms of the Apache 2.0 license that governs the use and distribution of the GACODE package. - -## Development Attribution - -GACODE was developed exclusively by Theory and Computational Science Group within the Magnetic Fusion Energy Division at General Atomics. - -## Trademark Notice - -The names "General Atomics", and any associated logos or images, are trademarks of General Atomics. Use of these trademarks without prior written consent from General Atomics is strictly prohibited. Users cannot imply endorsement by General Atomics or contributors to the project simply because the project is part of their work. - -## Copyright - -Copyright (c) 2003-2024 General Atomics - -## Version - -**Version: v1.0** diff --git a/README.rst b/README.rst index 03ae9e4c6..da2b10a67 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,23 @@ -GACODE -====== +Using GACODE +============ -For technical documentation, please refer to the `GACODE website `_. +GACODE is free software released under the Apache 2.0 license. The developers of GACODE recommend the following **best practices** -## Citation +1. Compile/use the Software source code AS IS for publication purposes. You are welcome and encouraged to request changes through the `github issues system `_, to make code modifications for testing purposes, or to issue pull requests +2. In published results or presentations, include the code name(s) and appropriate references in the table below -If you use any part of GACODE to publish in an academic journal, please cite the relevant components as follows: +.. csv-table:: **Appropriate References** + :header: "Physics code", "Topical Area", "Suitable citation" + :widths: 15,20,20 -| **CODE** | **Reference** | -|----------|-------------------------------------------------------------------------------| -| CGYRO | J. Candy, E.A. Belli, and R.V. Bravenec, J. Comput. Phys. **324** (2016) 73 | -| | [0.1016/j.jcp.2016.07.039](https://doi.org/10.1016/j.jcp.2016.07.039) | -| NEO | E.A. Belli and J. Candy, Plasma Phys. Control. Fusion **50** (2008) 095010 | -| | [10.1088/0741-3335/50/9/095010](https://doi.org/10.1088/0741-3335/50/9/095010)| + CGYRO, gyrokinetic simulation, `JCP2016 `_ + GYRO, gyrokinetic simulation, `JCP2003 `_ + NEO, neoclassical simulation, `PPCF2008 `_ | `PPCF2012 `_ + TGLF, transport model, `POP2007 `_ | `POP2010 `_ + TGYRO, profile evolution, `POP2009 `_ + +Source code and documentation +----------------------------- + +Source code is found in the `gacode repository `_. +For technical documentation, please refer to the `GACODE website `_.