Skip to content
Snippets Groups Projects
Commit 6e8987e7 authored by Luigi Sbailo's avatar Luigi Sbailo
Browse files

Add HU logo to tutorial template

parent f31b76f6
Branches
No related tags found
1 merge request!123testing develop merge
Show whitespace changes
Inline Side-by-side
analytics-tutorial-template/assets/tutorial_template/logo_HU.png 0 → 100644
+ 0
− 0
View file @ 6e8987e7
analytics-tutorial-template/assets/tutorial_template/logo_HU.png

449 KiB

analytics-tutorial-template/tutorial_template.ipynb
+ 3
− 2
View file @ 6e8987e7
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
<img src="assets/tutorial_template/header.jpg" width="900"> <img src="assets/tutorial_template/header.jpg" width="900">
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
<img style="float: left;" src="assets/tutorial_template/logo_NOMAD.png" width=300> <img style="float: left;" src="assets/tutorial_template/logo_MPG.png" width=150>
<img style="float: right;" src="assets/tutorial_template/logo_MPG.png" width=170> <img style="float: left; margin-top: -10px" src="assets/tutorial_template/logo_NOMAD.png" width=250>
<img style="float: left; margin-top: -5px" src="assets/tutorial_template/logo_HU.png" width=130>
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
This is a template for notebooks that aim to be published in the NOMAD AI Toolkit. This is a template for notebooks that aim to be published in the NOMAD AI Toolkit.
Above the header and logos. Please update the address of the header with the name of the tutorial (instead of 'tutorial_template' - the header will then be automatically generated with data taken from the 'metainfo.json' file at build time), and update with the logos of your institution. Above the header and logos. Please update the address of the header with the name of the tutorial (instead of 'tutorial_template' - the header will then be automatically generated with data taken from the 'metainfo.json' file at build time), and update with the logos of your institution.
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
## Import modules ## Import modules
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
External modules that are imported and that need to be installed in the local environment using pip, should be specified among the requirements in the 'setup.py' file. External modules that are imported and that need to be installed in the local environment using pip, should be specified among the requirements in the 'setup.py' file.
%% Cell type:code id: tags: %% Cell type:code id: tags:
``` python ``` python
import pandas as pd import pandas as pd
``` ```
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
Data are stored in './data/tutorial_template'. Data are stored in './data/tutorial_template'.
%% Cell type:code id: tags: %% Cell type:code id: tags:
``` python ``` python
df=pd.read_csv('./data/tutorial_template/data.csv', sep=',', index_col=0) df=pd.read_csv('./data/tutorial_template/data.csv', sep=',', index_col=0)
``` ```
%% Cell type:code id: tags: %% Cell type:code id: tags:
``` python ``` python
df df
``` ```
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
You can define functions that are called in the tutorial in the './tutorial_template' directory. You can define functions that are called in the tutorial in the './tutorial_template' directory.
%% Cell type:code id: tags: %% Cell type:code id: tags:
``` python ``` python
from tutorial_template.functions import print_atomic_mass_average from tutorial_template.functions import print_atomic_mass_average
``` ```
%% Cell type:code id: tags: %% Cell type:code id: tags:
``` python ``` python
print_atomic_mass_average(df) print_atomic_mass_average(df)
``` ```
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
Before pushing the notebook to its repository, please don't forget to clear the cell outputs: 'Cell' tab on the top -> 'All Output' -> 'Clear'. Then: 'File' -> 'Save'. Before pushing the notebook to its repository, please don't forget to clear the cell outputs: 'Cell' tab on the top -> 'All Output' -> 'Clear'. Then: 'File' -> 'Save'.
%% Cell type:markdown id: tags: %% Cell type:markdown id: tags:
# Markdown cheatsheet # Markdown cheatsheet
## Headings ## Headings
``` ```
# Heading 1 # Heading 1
# Heading 2 # Heading 2
## Heading 2.1 ## Heading 2.1
## Heading 2.2 ## Heading 2.2
``` ```
## Emphasis ## Emphasis
- Bold: __string__ or **string** - Bold: __string__ or **string**
- Italic: _string_ or *string* - Italic: _string_ or *string*
- Indented quoting: - Indented quoting:
> Hello world! > Hello world!
## Bullets/Numbered lists ## Bullets/Numbered lists
- item1 - item1
- item2 - item2
- subitem1 - subitem1
- subitem2 - subitem2
1. item1 1. item1
2. item2 2. item2
1. subitem1 1. subitem1
2. subitem2 2. subitem2
## Links ## Links
- Internal: [section title](#Import-modules) - Internal: [section title](#Import-modules)
- External: [Nomad Analytics](https://www.nomad-coe.eu/index.php?page=bigdata-analyticstoolkit) - External: [Nomad Analytics](https://www.nomad-coe.eu/index.php?page=bigdata-analyticstoolkit)
## Graphics ## Graphics
<img width="25%" src="https://nomad-coe.eu/uploads/nomad/images/NOMAD_Logo2.png" title="Title text" > <img width="25%" src="https://nomad-coe.eu/uploads/nomad/images/NOMAD_Logo2.png" title="Title text" >
## Mathematical symbols: ## Mathematical symbols:
- Inline: $e^{i\pi} + 1 = 0$ or - Inline: $e^{i\pi} + 1 = 0$ or
$$e^x=\sum_{i=0}^\infty \frac{1}{i!}x^i$$ $$e^x=\sum_{i=0}^\infty \frac{1}{i!}x^i$$
## Embeded code ## Embeded code
```python ```python
def f(x): def f(x):
"""a docstring""" """a docstring"""
return x**2 return x**2
``` ```
or refering to a `function`. or refering to a `function`.
## Table ## Table
| This | is | | This | is |
|------|------| |------|------|
| a | table| | a | table|
## Horizontal lines ## Horizontal lines
*** ***
or or
--- ---
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment