Skip to content

Commit 360b68d

Browse files
committed
Add README and proper index
1 parent 370bbe2 commit 360b68d

1 file changed

Lines changed: 16 additions & 160 deletions

File tree

docs/index.md

Lines changed: 16 additions & 160 deletions
Original file line numberDiff line numberDiff line change
@@ -2,172 +2,28 @@
22
icon: lucide/rocket
33
---
44

5-
# Get started
5+
# EESSI Tutorial
66

7-
For full documentation visit [zensical.org](https://zensical.org/docs/).
7+
Welcome to this tutorial on the [**European Environment for Scientific Software Installations (EESSI)**](https://www.eessi.io/docs/).
88

9-
## Commands
9+
EESSI provides a shared, portable, and optimized software stack for scientific computing across a wide range of HPC systems and Linux environments.
1010

11-
* [`zensical new`][new] - Create a new project
12-
* [`zensical serve`][serve] - Start local web server
13-
* [`zensical build`][build] - Build your site
11+
## Tutorial Contents
1412

15-
[new]: https://zensical.org/docs/usage/new/
16-
[serve]: https://zensical.org/docs/usage/preview/
17-
[build]: https://zensical.org/docs/usage/build/
13+
1. [Getting Access to EESSI](eessi-getting-access.md)
14+
2. [Introduction to EESSI](eessi-introduction.md)
15+
3. [Using EESSI](eessi-usage.md)
16+
4. [EESSI Use Cases](eessi-use-cases.md)
1817

19-
## Examples
18+
## Learning Objectives
2019

21-
### Admonitions
20+
After completing this tutorial, you will be able to:
2221

23-
> Go to [documentation](https://zensical.org/docs/authoring/admonitions/)
22+
- Explain the purpose and benefits of EESSI.
23+
- Access EESSI on supported systems.
24+
- Run software provided through EESSI.
25+
- Identify scenarios where EESSI can simplify scientific software deployment and usage.
2426

25-
!!! note
27+
## Audience
2628

27-
This is a **note** admonition. Use it to provide helpful information.
28-
29-
!!! warning
30-
31-
This is a **warning** admonition. Be careful!
32-
33-
### Details
34-
35-
> Go to [documentation](https://zensical.org/docs/authoring/admonitions/#collapsible-blocks)
36-
37-
??? info "Click to expand for more info"
38-
39-
This content is hidden until you click to expand it.
40-
Great for FAQs or long explanations.
41-
42-
## Code Blocks
43-
44-
> Go to [documentation](https://zensical.org/docs/authoring/code-blocks/)
45-
46-
``` python hl_lines="2" title="Code blocks"
47-
def greet(name):
48-
print(f"Hello, {name}!") # (1)!
49-
50-
greet("Python")
51-
```
52-
53-
1. > Go to [documentation](https://zensical.org/docs/authoring/code-blocks/#code-annotations)
54-
55-
Code annotations allow to attach notes to lines of code.
56-
57-
Code can also be highlighted inline: `#!python print("Hello, Python!")`.
58-
59-
## Content tabs
60-
61-
> Go to [documentation](https://zensical.org/docs/authoring/content-tabs/)
62-
63-
=== "Python"
64-
65-
``` python
66-
print("Hello from Python!")
67-
```
68-
69-
=== "Rust"
70-
71-
``` rs
72-
println!("Hello from Rust!");
73-
```
74-
75-
## Diagrams
76-
77-
> Go to [documentation](https://zensical.org/docs/authoring/diagrams/)
78-
79-
``` mermaid
80-
graph LR
81-
A[Start] --> B{Error?};
82-
B -->|Yes| C[Hmm...];
83-
C --> D[Debug];
84-
D --> B;
85-
B ---->|No| E[Yay!];
86-
```
87-
88-
## Footnotes
89-
90-
> Go to [documentation](https://zensical.org/docs/authoring/footnotes/)
91-
92-
Here's a sentence with a footnote.[^1]
93-
94-
Hover it, to see a tooltip.
95-
96-
[^1]: This is the footnote.
97-
98-
99-
## Formatting
100-
101-
> Go to [documentation](https://zensical.org/docs/authoring/formatting/)
102-
103-
- ==This was marked (highlight)==
104-
- ^^This was inserted (underline)^^
105-
- ~~This was deleted (strikethrough)~~
106-
- H~2~O
107-
- A^T^A
108-
- ++ctrl+alt+del++
109-
110-
## Icons, Emojis
111-
112-
> Go to [documentation](https://zensical.org/docs/authoring/icons-emojis/)
113-
114-
* :sparkles: `:sparkles:`
115-
* :rocket: `:rocket:`
116-
* :tada: `:tada:`
117-
* :memo: `:memo:`
118-
* :eyes: `:eyes:`
119-
120-
## Maths
121-
122-
> Go to [documentation](https://zensical.org/docs/authoring/math/)
123-
124-
$$
125-
\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k}
126-
$$
127-
128-
!!! warning "Needs configuration"
129-
Note that MathJax is included via a `script` tag on this page and is not
130-
configured in the generated default configuration to avoid including it
131-
in a pages that do not need it. See the documentation for details on how
132-
to configure it on all your pages if they are more Maths-heavy than these
133-
simple starter pages.
134-
135-
<script id="MathJax-script" src="https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"></script>
136-
<script>
137-
window.MathJax = {
138-
tex: {
139-
inlineMath: [["\\(", "\\)"]],
140-
displayMath: [["\\[", "\\]"]],
141-
processEscapes: true,
142-
processEnvironments: true
143-
},
144-
options: {
145-
ignoreHtmlClass: ".*|",
146-
processHtmlClass: "arithmatex"
147-
}
148-
};
149-
150-
document$.subscribe(() => {
151-
MathJax.startup.output.clearCache()
152-
MathJax.typesetClear()
153-
MathJax.texReset()
154-
MathJax.typesetPromise()
155-
})
156-
</script>
157-
158-
## Task Lists
159-
160-
> Go to [documentation](https://zensical.org/docs/authoring/lists/#using-task-lists)
161-
162-
* [x] Install Zensical
163-
* [x] Configure `zensical.toml`
164-
* [x] Write amazing documentation
165-
* [ ] Deploy anywhere
166-
167-
## Tooltips
168-
169-
> Go to [documentation](https://zensical.org/docs/authoring/tooltips/)
170-
171-
[Hover me][example]
172-
173-
[example]: https://example.com "I'm a tooltip!"
29+
This tutorial is intended for researchers, students, HPC users, and system administrators who want to use scientific software through EESSI.

0 commit comments

Comments
 (0)