Skip to content

Commit

Permalink
Preparing for open version of GACODE
Browse files Browse the repository at this point in the history
  • Loading branch information
jcandy committed Oct 22, 2024
1 parent a2f960c commit 179a43e
Show file tree
Hide file tree
Showing 7 changed files with 164 additions and 145 deletions.
23 changes: 23 additions & 0 deletions html/src/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Using GACODE
============

GACODE is free software released under the Apache 2.0 license. The developers of GACODE recommend the following **best practices**

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

.. csv-table:: **Appropriate References**
:header: "Physics code", "Topical Area", "Suitable citation"
:widths: 15,20,20

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>`_.
27 changes: 0 additions & 27 deletions html/src/USER_AGREEMENT.txt

This file was deleted.

4 changes: 2 additions & 2 deletions html/src/cgyro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Simulation data courtesy Nathan Howard (MIT)
:width: 48 %
:alt: b1480

Source Code
-----------
CGYRO Source Code
-----------------

`CGYRO source code <http://github.com/gafusion/gacode>`_ is available at GitHub.

Expand Down
27 changes: 0 additions & 27 deletions html/src/download.rst

This file was deleted.

3 changes: 1 addition & 2 deletions html/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@ GACODE software works with the :ref:`input.gacode` format.
:maxdepth: 4
:caption: Software

license
download
README
setup
build
zreferences
Expand Down
35 changes: 0 additions & 35 deletions html/src/license.rst

This file was deleted.

Loading

0 comments on commit 179a43e

Please sign in to comment.