From 05dd4962e9f4d769e916d81752864e49f5567e35 Mon Sep 17 00:00:00 2001
From: Theo Brown <7982453+theo-brown@users.noreply.github.com>
Date: Sun, 6 Jul 2025 17:56:37 +0100
Subject: [PATCH] Add links to FreeGSNKE docs in README
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 3dddc2f..8e5f47d 100644
--- a/README.md
+++ b/README.md
@@ -3,16 +3,16 @@
FreeGS4E is a package forked from [FreeGS](https://github.com/freegs-plasma/freegs) (v0.6.1), which has the capability to solve the static inverse free-boundary Grad-Shafranov problem for plasma equilibria in tokamak devices.
-Its intended usage is as an underlying solver for the dynamic (time-dependent) free-boundary equilibrium solver FreeGSNKE.
+Its intended usage is as an underlying solver for the dynamic (time-dependent) free-boundary equilibrium solver [FreeGSNKE](https://github.com/FusionComputingLab/freegsnke).
The addtion and removal of certain features within FreeGS, as well as some performance optimisation, were neccesary to enable this and so FreeGS4E has now diverged significantly from original FreeGS codebase.
-Therefore, FreeGS4E is **not intended to be a drop in replacement solver for FreeGS** but rather is designed for use explicitly **within** FreeGSNKE.
+Therefore, FreeGS4E is **not intended to be a drop in replacement solver for FreeGS** but rather is designed for use explicitly **within** [FreeGSNKE](https://github.com/FusionComputingLab/freegsnke).
## Installation
-Given FreeGS4E is not a standalone equilibrium solver, we recommend following the installation instructions for FreeGSNKE (which will install FreeGS4E automatically).
+Given FreeGS4E is not a standalone equilibrium solver, we recommend following the [installation instructions for FreeGSNKE](https://docs.freegsnke.com/#installation) (which will install FreeGS4E automatically).
If you would, however, like to contribute to FreeGS4E directly, please see the installation instructions in the section on contributing below.
@@ -69,4 +69,4 @@ pre-commit install
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
- along with this program. If not, see .
\ No newline at end of file
+ along with this program. If not, see .