Skip to content

Commit 7acda4c

Browse files
Update index.md
1 parent 7569ec3 commit 7acda4c

File tree

1 file changed

+1
-180
lines changed

1 file changed

+1
-180
lines changed

index.md

Lines changed: 1 addition & 180 deletions
Original file line numberDiff line numberDiff line change
@@ -48,190 +48,11 @@ Inversion algorithms:
4848
* [InverseAlgos.jl](https://github.com/GinvLab/InverseAlgos.jl) [[docs](https://ginvlab.github.io/InverseAlgos.jl)] Inversion algorithm subdivided in three sub-modules/categories:
4949

5050
- **Hamiltonian Monte Carlo** and "classic" **Metropolis-Hastings** samplers. Includes the "plain" HMC, the NUTS algorithms et al..
51-
- **Optimization**. Currently only the L-BFGS algorithm (with optional box constraints) is implemented.
51+
- **Optimization**. Currently the L-BFGS and Gauss-Newton algorithms (with optional box constraints) are implemented.
5252
- **Linear inverse problems under Gaussian uncertainties**. Kronecker product-based inversion (`KronLinInv`) and classic least squares.
5353

5454

5555
Examples/tutorials:
5656

5757
* [GinvLab-examples](https://github.com/GinvLab/GinvLab-examples.jl) [[docs](https://ginvlab.github.io/GinvLab-examples.jl)] A set of scripts and Jupyter notebooks illustrating some simple example problems solved using the packages part of G⁻¹Lab.
5858

59-
60-
61-
62-
<!-- Ps: if you want to modify the header or footer or the general look of the website, adjust the files in -->
63-
<!-- * `src/_css/` and -->
64-
<!-- * `src/_html_parts/`. -->
65-
66-
<!-- ## The base with Markdown -->
67-
68-
<!-- The [standard markdown syntax](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) can be used such as titles using `#`, lists: -->
69-
70-
<!-- * element with **bold** -->
71-
<!-- * element with _emph_ -->
72-
73-
<!-- or code-blocks `inline` or with highlighting (note the `@def hascode = true` in the source to allow [highlight.js](https://highlightjs.org/) to do its job): -->
74-
75-
<!-- ```julia -->
76-
<!-- abstract type Point end -->
77-
<!-- struct PointR2{T<:Real} <: Point -->
78-
<!-- x::T -->
79-
<!-- y::T -->
80-
<!-- end -->
81-
<!-- struct PointR3{T<:Real} <: Point -->
82-
<!-- x::T -->
83-
<!-- y::T -->
84-
<!-- z::T -->
85-
<!-- end -->
86-
<!-- function len(p::T) where T<:Point -->
87-
<!-- sqrt(sum(getfield(p, η)^2 for η ∈ fieldnames(T))) -->
88-
<!-- end -->
89-
<!-- ``` -->
90-
91-
<!-- You can also quote stuff -->
92-
93-
<!-- > You must have chaos within you to ... -->
94-
95-
<!-- or have tables: -->
96-
97-
<!-- | English | Mandarin | -->
98-
<!-- | --------------- | ---------- | -->
99-
<!-- | winnie the pooh | 维尼熊 | -->
100-
101-
<!-- Note that you may have to do a bit of CSS-styling to get these elements to look the way you want them (the same holds for the whole page in fact). -->
102-
103-
<!-- ### Symbols and html entities -->
104-
105-
<!-- If you want a dollar sign you have to escape it like so: \$, you can also use html entities like so: &rarr; or &pi; or, if you're using Juno for instance, you can use `\pi[TAB]` to insert the symbol as is: π (it will be converted to a html entity).[^1] -->
106-
107-
<!-- If you want to show a backslash, just use it like so: \ ; if you want to force a line break, use a ` \\ ` like \\ so (this is on a new line).[^blah] -->
108-
109-
<!-- If you want to show a backtick, escape it like so: \` and if you want to show a tick in inline code use double backticks like ``so ` ...``. -->
110-
111-
<!-- Footnotes are nice too: -->
112-
113-
<!-- [^1]: this is the text for the first footnote, you can style all this looking at `.fndef` elements; note that the whole footnote definition is _expected to be on the same line_. -->
114-
<!-- [^blah]: and this is a longer footnote with some blah from veggie ipsum: turnip greens yarrow ricebean rutabaga endive cauliflower sea lettuce kohlrabi amaranth water spinach avocado daikon napa cabbage asparagus winter purslane kale. Celery potato scallion desert raisin horseradish spinach carrot soko. -->
115-
116-
<!-- ## Basic Franklin extensions -->
117-
118-
<!-- ### Divs -->
119-
120-
<!-- It is sometimes useful to have a short way to make a part of the page belong to a div so that it can be styled separately. -->
121-
<!-- You can do this easily with Franklin by using `@@divname ... @@`. -->
122-
<!-- For instance, you could want a blue background behind some text. -->
123-
124-
<!-- @@colbox-blue -->
125-
<!-- Here we go! (this is styled in the css sheet with name "colbox-blue"). -->
126-
<!-- @@ -->
127-
128-
<!-- Since it's just a `<div>` block, you can put this construction wherever you like and locally style your text. -->
129-
130-
<!-- ### LaTeX and Maths -->
131-
132-
<!-- Essentially three things are imitated from LaTeX -->
133-
134-
<!-- 1. you can introduce definitions using `\newcommand` -->
135-
<!-- 1. you can use hyper-references with `\eqref`, `\cite`, ... -->
136-
<!-- 1. you can show nice maths (via KaTeX) -->
137-
138-
<!-- The definitions can be introduced in the page or in the `config.md` (in which case they're available everywhere as opposed to just in that page). -->
139-
<!-- For instance, the commands `\scal` and `\R` are defined in the config file (see `src/config.md`) and can directly be used whereas the command `\E` is defined below (and therefore only available on this page): -->
140-
141-
<!-- \newcommand{\E}[1]{\mathbb E\left[#1\right]} -->
142-
143-
<!-- Now we can write something like -->
144-
145-
<!-- $$ \varphi(\E{X}) \le \E{\varphi(X)}. \label{equation blah} $$ -->
146-
147-
<!-- since we've given it the label `\label{equation blah}`, we can refer it like so: \eqref{equation blah} which can be convenient for pages that are math-heavy. -->
148-
149-
<!-- In a similar vein you can cite references that would be at the bottom of the page: \citep{noether15, bezanson17}. -->
150-
151-
<!-- **Note**: the LaTeX commands you define can also incorporate standard markdown (though not in a math environment) so for instance let's define a silly `\bolditalic` command. -->
152-
153-
<!-- \newcommand{\bolditalic}[1]{_**!#1**_} <\!--_ ignore this comment, it helps atom to not get confused by the trailing underscore when highlighting the code but is not necessary.-\-> -->
154-
155-
<!-- and use it \bolditalic{here for example}. -->
156-
157-
<!-- Here's another quick one, a command to change the color: -->
158-
159-
<!-- \newcommand{\col}[2]{~~~<span style="color:~~~#1~~~">~~~!#2~~~</span>~~~} -->
160-
161-
<!-- This is \col{blue}{in blue} or \col{#bf37bc}{in #bf37bc}. -->
162-
163-
<!-- ### A quick note on whitespaces -->
164-
165-
<!-- For most commands you will use `#k` to refer to the $k$-th argument as in LaTeX. -->
166-
<!-- In order to reduce headaches, this forcibly introduces a whitespace on the left of whatever is inserted which, usually, changes nothing visible (e.g. in a math settings). -->
167-
<!-- However there _may be_ situations where you do not want this to happen and you know that the insertion will not clash with anything else. -->
168-
<!-- In that case, you should simply use `!#k` which will not introduce that whitespace. -->
169-
<!-- It's probably easier to see this in action: -->
170-
171-
<!-- \newcommand{\pathwith}[1]{`/usr/local/bin/#1`} -->
172-
<!-- \newcommand{\pathwithout}[1]{`/usr/local/bin/!#1`} -->
173-
174-
<!-- * with: \pathwith{script.jl}, there's a whitespace you don't want 🚫 -->
175-
<!-- * without: \pathwithout{script.jl} here there isn't ✅ -->
176-
177-
<!-- ### Raw HTML -->
178-
179-
<!-- You can include raw HTML by just surrounding a block with `~~~`. -->
180-
<!-- Not much more to add. -->
181-
<!-- This may be useful for local custom layouts like having a photo next to a text in a specific way. -->
182-
183-
<!-- ~~~ -->
184-
<!-- <div class="row"> -->
185-
<!-- <div class="container"> -->
186-
<!-- <img class="left" src="/assets/rndimg.jpg"> -->
187-
<!-- <p> -->
188-
<!-- Marine iguanas are truly splendid creatures. They're found on the Gálapagos islands, have skin that basically acts as a solar panel, can swim and may have the ability to adapt their body size depending on whether there's food or not. -->
189-
<!-- </p> -->
190-
<!-- <p> -->
191-
<!-- Evolution is cool. -->
192-
<!-- </p> -->
193-
<!-- <div style="clear: both"></div> -->
194-
<!-- </div> -->
195-
<!-- </div> -->
196-
<!-- ~~~ -->
197-
198-
<!-- **Note 1**: again, entire such blocks can be made into latex-like commands via `\newcommand{\mynewblock}[1]{...}`. -->
199-
200-
<!-- **Note 2**: whatever is in a raw HTML block is *not* further processed (so you can't have LaTeX in there for instance). A partial way around this is to use `@@...` blocks which *will* be recursively parsed. The following code gives the same result as above with the small difference that there is LaTeX being processed in the inner div. -->
201-
202-
<!-- @@row -->
203-
<!-- @@container -->
204-
<!-- @@left ![](/assets/rndimg.jpg) @@ -->
205-
<!-- @@ -->
206-
<!-- Marine iguanas are **truly splendid** creatures. They're not found in equations like $\exp(-i\pi)+1$. But they're still quite cool. -->
207-
<!-- ~~~ -->
208-
<!-- <div style="clear: both"></div> -->
209-
<!-- ~~~ -->
210-
<!-- @@ -->
211-
212-
<!-- ## Pages and structure -->
213-
214-
<!-- Here are a few empty pages connecting to the menu links to show where files can go and the resulting paths. (It's probably best if you look at the source folder for this). -->
215-
216-
<!-- * [menu 1](/menu1/) -->
217-
<!-- * [menu 2](/menu2/) -->
218-
<!-- * [menu 3](/menu3/) -->
219-
220-
<!-- ## References (not really) -->
221-
222-
<!-- * \biblabel{noether15}{Noether (1915)} **Noether**, Körper und Systeme rationaler Funktionen, 1915. -->
223-
<!-- * \biblabel{bezanson17}{Bezanson et al. (2017)} **Bezanson**, **Edelman**, **Karpinski** and **Shah**, [Julia: a fresh approach to numerical computing](https://julialang.org/research/julia-fresh-approach-BEKS.pdf), SIAM review 2017. -->
224-
225-
<!-- ## Header and Footer -->
226-
227-
<!-- As you can see here at the bottom of the page, there is a footer which you may want on all pages but for instance you may want the date of last modification to be displayed. -->
228-
<!-- In a fashion heavily inspired by [Hugo](https://gohugo.io), you can write things like -->
229-
230-
<!-- ```html -->
231-
<!-- Last modified: {{ fill fd_mtime }}. -->
232-
<!-- ``` -->
233-
234-
<!-- (cf. `src/_html_parts/page_foot.html`) which will then replace these braces with the content of a dictionary of variables at the key `fd_mtime`. -->
235-
<!-- This dictionary of variables is accessed locally by pages through `@def varname = value` and globally through the `config.md` page via the same syntax. -->
236-
237-
<!-- There's a few other such functions of the form `{{fname p₁ p₂}}` as well as support for conditional blocks. If you wander through the `src/_html_parts/` folder and its content, you should be able to see those in action. -->

0 commit comments

Comments
 (0)