-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from ProjectTorreyPines/edit_documentation
update NOTICE from FUSE default
- Loading branch information
Showing
2 changed files
with
17 additions
and
6 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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,14 +1,21 @@ | ||
# TGLFNN.jl | ||
|
||
Run TGLFNN, TGLF, and QLGYRO models | ||
Run TGLF-NN, TGLF, and QLGYRO models | ||
|
||
NOTE: Running TGLF and QLGYRO requires GACODE executables to be locally installed. | ||
|
||
Link to instructions on GACODE installation: https://fuse.help/install.html#Install-GACODE | ||
|
||
See the note following step 6 - you may need to replace mpif90-openmpi-mp with mpif90-openmpi-gcc12 in the platform-specific make file found in $GACODE_ROOT/platform/build/make.inc.OSX_MONTEREY and mpirun-openmpi-mp with mpirun-openmpi-gcc12 in the platform exec file found in $GACODE_ROOT/platform/exec/exec.OSX_MONTEREY. | ||
Link to instructions on GACODE installation: https://gacode.io/build.html | ||
|
||
## Online documentation | ||
For more details, see the [online documentation](https://projecttorreypines.github.io/TGLFNN.jl/dev). | ||
|
||
![Docs](https://github.com/ProjectTorreyPines/TGLFNN.jl/actions/workflows/make_docs.yml/badge.svg) | ||
|
||
If this software contributes to an academic publication, please cite it as follows: | ||
|
||
## Citation | ||
TGLF-NN: | ||
> Tom Neiser, Orso Meneghini, Sterling Smith, Joseph McClenaghan, David Orozco, Joseph Hall, Gary Staebler, Emily Belli, Jeff Candy, _Database generation for validation of TGLF and retraining of neural network accelerated TGLF-NN_, APS Division of Plasma Physics Meeting Abstracts (2022) | ||
GKNN: | ||
> Tom Neiser, Orso Meneghini, Sterling Smith, Joseph McClenaghan, Tim Slendebroek, David Orozco, Brian Sammuli, Gary Staebler, Joseph Hall, Emily Belli, Jeff Candy, _Multi-fidelity neural network representation of gyrokinetic turbulence_, APS Division of Plasma Physics Meeting Abstracts (2023) |