From 66a91990def9694d856758d7ea6a3a8d2f0eb805 Mon Sep 17 00:00:00 2001 From: Anchal Gupta Date: Thu, 24 Oct 2024 09:18:45 +0200 Subject: [PATCH] Updating documentation for new name and purpose --- README.md | 18 ++++++++---------- docs/src/index.md | 11 +++++++++-- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fc014bb..27e55c7 100644 --- a/README.md +++ b/README.md @@ -5,16 +5,14 @@ ![Tests](https://github.com/ProjectTorreyPines/SOLPS2ctrl.jl/actions/workflows/test.yml/badge.svg) [![codecov](https://codecov.io/gh/ProjectTorreyPines/SOLPS2ctrl.jl/graph/badge.svg?token=ZJBRLAXIS1)](https://codecov.io/gh/ProjectTorreyPines/SOLPS2ctrl.jl) -Synthetic diagnostic workflow manager for use with SOLPS models - -This repository is the top level layer for managing a workflow for calculating -the outputs of synthetic diagnostics attached to a SOLPS model. - -Steps: -1) Load SOLPS into IMAS DD format if not already -2) Load equilibrium (that the SOLPS mesh was based on) into IMAS DD format -3) Make assumptions to extend profiles into the core and far SOL, if needed -4) Run synthetic diagnostic models and record output +This repository is the top level layer for managing workflow for: + +* Loading SOLPS outputs into IMAS data dictionary format +* Loading equilibrium (that the SOLPS mesh was based on) into IMAS DD format +* Extrapolating results into core and far SOL region if required +* Running synthetic diagnostics on them +* Performing system identification (to be added) +* Designing and tuning linear causal and model predictive controllers (to be added) For installation and usage instructions, see the [online documentation](https://projecttorreypines.github.io/SOLPS2ctrl.jl/stable). For documentation on under development branch, see [dev online documentation](https://projecttorreypines.github.io/SOLPS2ctrl.jl/dev). diff --git a/docs/src/index.md b/docs/src/index.md index d170cf0..9331857 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -6,7 +6,14 @@ Pages = ["index.md"] Depth = 3 ``` -This repository serves as the top most workflow manager with helpful utilities to use other repositories in this project. +This repository serves as the top most workflow manager with helpful utilities to use other repositories in this project. Following steps are supported/planned in near future: + +* Loading SOLPS outputs into IMAS data dictionary format +* Loading equilibrium (that the SOLPS mesh was based on) into IMAS DD format +* Extrapolating results into core and far SOL region if required +* Running synthetic diagnostics on them +* Performing system identification (to be added) +* Designing and tuning linear causal and model predictive controllers (to be added) ## Documentation of other repositories in this project @@ -14,7 +21,7 @@ This repository serves as the top most workflow manager with helpful utilities t ### [SOLPS2imas.jl](https://projecttorreypines.github.io/SOLPS2imas.jl/stable) -### [SynthDiag.jl](https://projecttorreypines.github.io/SynthDiag.jl/stable) +### [FusionSyntheticDiagnostics.jl](https://projecttorreypines.github.io/FusionSyntheticDiagnostics.jl/stable) SOLPS2ctrl is registered with public repository [FuseRegistry](https://github.com/ProjectTorreyPines/FuseRegistry.jl/). For installation: