Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
jcandy committed Oct 22, 2024
1 parent 20c077d commit 4358605
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 30 deletions.
4 changes: 4 additions & 0 deletions NOTICE
Original file line number Diff line number Diff line change
@@ -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.
19 changes: 0 additions & 19 deletions NOTICE.md

This file was deleted.

30 changes: 19 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
GACODE
======
Using GACODE
============

For technical documentation, please refer to the `GACODE website <http://gacode.io>`_.
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 <https://github.com/gafusion/gacode/issues>`_, 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 <https://doi.org/10.1016/j.jcp.2016.07.039>`_
GYRO, gyrokinetic simulation, `JCP2003 <https://doi.org/10.1016/S0021-9991(03)00079-2>`_
NEO, neoclassical simulation, `PPCF2008 <https://doi.org/10.1088/0741-3335/50/9/095010>`_ | `PPCF2012 <https://doi.org/10.1088/0741-3335/54/1/015015>`_
TGLF, transport model, `POP2007 <https://doi.org/10.1063/1.2436852>`_ | `POP2010 <https://doi.org/10.1063/1.3505308>`_
TGYRO, profile evolution, `POP2009 <https://doi.org/10.1063/1.3167820>`_

Source code and documentation
-----------------------------

Source code is found in the `gacode repository <https://github.com/gafusion>`_.
For technical documentation, please refer to the `GACODE website <https://gacode.io>`_.

0 comments on commit 4358605

Please sign in to comment.