From 87fa451df4416c9bc197add54aaa292d3c9b899d Mon Sep 17 00:00:00 2001
From: Michiel Cottaar <MichielCottaar@protonmail.com>
Date: Wed, 15 May 2024 14:04:22 +0100
Subject: [PATCH] DOC: Add section on pre-implemented sequences
---
docs/make.jl | 1 +
docs/src/implemented_sequences.md | 17 +++++++++++++++++
2 files changed, 18 insertions(+)
create mode 100644 docs/src/implemented_sequences.md
diff --git a/docs/make.jl b/docs/make.jl
index 80a5d7c..719f460 100644
--- a/docs/make.jl
+++ b/docs/make.jl
@@ -17,6 +17,7 @@ makedocs(;
),
pages=[
"Home" => "index.md",
+ "Implemented sequences" => "implemented_sequences.md"
"API" => "api.md",
],
warnonly=Documenter.except(:example_block),
diff --git a/docs/src/implemented_sequences.md b/docs/src/implemented_sequences.md
new file mode 100644
index 0000000..f610c6b
--- /dev/null
+++ b/docs/src/implemented_sequences.md
@@ -0,0 +1,17 @@
+# Using implemented sequences (@id implemented_sequences)
+
+## Usage
+
+MRIBuilder comes with several sequences pre-defined.
+Each sequence can be created through a simple function call.
+To get help on a specific sequence, either follow the link in the sequence list below or type `?<function_name>` in Julia.
+
+When reading the help, you will notice that there are two type of expected inputs:
+- `Parameters`: these define the type of components that will be includes, e.g., the shape of the excitation pulse or the readout strategy. These parameters have to be set to certain fixed values. If unset, they will be determined by their default value as defined in the documentation.
+- `Variables`: These are a special type of parameters. In addition to being set to a fixed value, they can also be set to `:min` or `:max` to minimise or maximise the variable. If they are unset, they will be determined based on the other variables.
+Internally whenever you call a sequence function it will run a non-linear optimisation given any constraints and/or objectives you have given to the `Variables`. It will give a single sequence that matches all of the constraints. If no solution exists, an error will be raised instead. If multiple solutions exist, a single (somewhat random) one is returned.
+
+## Available sequences
+```@autodocs
+Modules = [MRIBuilder.Sequences]
+```
\ No newline at end of file
--
GitLab