Create a tutorial_template with consisten naming

tutorial_template/.gitignore

-# Ignore everything in this directory
-*
-# Except this file
-!.gitignore
+.idea
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
\ No newline at end of file
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

tutorial_template/README.md

+# analytics-tutorial-template
+
+This repository contains a skeleton of a tutorial with all of the templates. 
+
+To create/integrate a new tutorial there are a few requirements that has to be fulfilled.
+Each tutorial has to have a to be installable. 
+
+File structure af a tutorial:
+- `metainfo.json`: contains some data about the tutorial. This file is used to update the information on the website. The same data can be used for the python packeage as well. 
+- `setup.py`: provides an easy way to access any code available in the python environments. Most importantly it should contain all of the dependencies of the tutorial 
+- `data`: folder that stores all the data required in this folder.
+- `assets`: folder for storing any additional materials (logos, figure, etc.) 
+
+
+## Tips and tricks
+
+- Please note that during the deployment these folders (`data`, `assets`) from other tutorials will be merged so if you want to be on the safe side you can use sub-folders as well.
+- the namo of th jupyter notebook could be the same as the name of repository. 
+
+## Notes
+
+- More information about the python `setup.py` file: https://docs.python.org/3/distutils/setupscript.html
+- `json` vs. `yaml`: Yaml looks nicer but currently only the json format is supported natively by Python.
\ No newline at end of file

tutorial_template/assets/tutorial_template/.gitignore

+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
\ No newline at end of file

tutorial_template/data/tutorial_template/.gitignore

+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
\ No newline at end of file

tutorial_template/metainfo.json

+{
+  "authors": [
+    "Surname, First name",
+    "Surname, First name",
+    "Surname, First name"
+  ],
+  "email": "user@domain.com",
+  "title": "Title of the tutorial",
+  "description": "In this tutorial we will ...",
+  "notebook_name": "tutorial_template.ipynb",
+  "url": "https://gitlab.mpcdf.mpg.de/nomad-lab/analytics-tutorial-template",
+  "link": "https://analytics-toolkit.nomad-coe.eu/hub/user-redirect/notebooks/tutorials/tutorial_template.ipynb",
+  "link_public": "https://analytics-toolkit.nomad-coe.eu/public/user-redirect/notebooks/tutorials/tutorial_template.ipynb",
+  "link_paper": "https://.../.pdf",
+  "link_doi_paper": "https://www.nature.com/articles/...",
+  "updated": "2020-04-09",
+  "flags":{
+    "featured": true,
+    "top_of_list": false,
+    "paper": true
+  },
+  "labels": {
+    "application_section": [
+      "Keyword",
+    ],
+    "application_system": [
+      "System_property_1",
+      "System_property_2",
+      "System_property_n"
+    ],
+    "category": [
+      "keyword"
+    ],
+    "ai_methods": [
+      "AI_method_1",
+      "AI_method_2",
+      "AI_method_n"
+    ],
+    "platform": [
+      "jupyter"
+    ]
+  }
+}
\ No newline at end of file

tutorial_template/setup.py

+import json
+from setuptools import setup, find_packages
+
+with open('metainfo.json') as file:
+    metainfo = json.load(file)
+
+setup(
+    name='template_tutorial',
+    version='1.0',
+    author=', '.join(metainfo['authors']),
+    author_email=metainfo['email'],
+    url=metainfo['url'],
+    description=metainfo['title'],
+    long_description=metainfo['description'],
+    packages=find_packages(),
+    install_requires=['numpy', 'scipy'],
+)

tutorial_template/tutorial_template.ipynb

+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<img  src=\"assets/tutorial_template/header.jpg\" width=\"900\"> "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "<img  style=\"float: left;\" src=\"assets/tutorial_template/logo_NOMAD.png\" width=300>\n",
+    "<img  style=\"float: right;\" src=\"assets/tutorial_template/logo_MPG.png\" width=170> "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This interactive notebook ...\n",
+    "\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Markdown cheatsheet\n",
+    "\n",
+    "\n",
+    "## Headings\n",
+    "\n",
+    "```\n",
+    "# Heading 1\n",
+    "# Heading 2\n",
+    "## Heading 2.1\n",
+    "## Heading 2.2\n",
+    "```\n",
+    "\n",
+    "\n",
+    "## Emphasis\n",
+    "\n",
+    "- Bold: __string__ or **string**\n",
+    "- Italic: _string_ or *string*\n",
+    "- Indented quoting:\n",
+    "\n",
+    "> Hello world!\n",
+    "\n",
+    "\n",
+    "## Bullets/Numbered lists\n",
+    "\n",
+    "- item1\n",
+    "- item2\n",
+    "  - subitem1\n",
+    "  - subitem2\n",
+    "\n",
+    "\n",
+    "1. item1\n",
+    "2. item2\n",
+    "   1. subitem1\n",
+    "   2. subitem2\n",
+    "\n",
+    "\n",
+    "## Links\n",
+    "\n",
+    "- Internal: [section title](#Import-modules)\n",
+    "- External: [Nomad Analytics](https://www.nomad-coe.eu/index.php?page=bigdata-analyticstoolkit)\n",
+    "\n",
+    "\n",
+    "## Graphics\n",
+    "\n",
+    "<img width=\"25%\" src=\"https://nomad-coe.eu/uploads/nomad/images/NOMAD_Logo2.png\" title=\"Title text\" >\n",
+    "\n",
+    "\n",
+    "## Mathematical symbols: \n",
+    "\n",
+    "- Inline: $e^{i\\pi} + 1 = 0$ or\n",
+    "\n",
+    "$$e^x=\\sum_{i=0}^\\infty \\frac{1}{i!}x^i$$\n",
+    "\n",
+    "\n",
+    "## Emeded code\n",
+    "\n",
+    "```python\n",
+    "def f(x):\n",
+    "   \"\"\"a docstring\"\"\"\n",
+    "    return x**2\n",
+    "```\n",
+    "\n",
+    "or refering to a `function`.\n",
+    "\n",
+    "\n",
+    "\n",
+    "## Table\n",
+    "\n",
+    "| This | is   |\n",
+    "|------|------|\n",
+    "|   a  | table|\n",
+    "\n",
+    "\n",
+    "## Horizontal lines\n",
+    "\n",
+    "***\n",
+    "\n",
+    "or \n",
+    "\n",
+    "---\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Import modules"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import numpy as np\n",
+    "import matplotlib.pyplot as plt"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "hide_input": false,
+  "kernelspec": {
+   "display_name": "Python 3 (ipykernel)",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.7"
+  },
+  "toc": {
+   "base_numbering": "0",
+   "nav_menu": {},
+   "number_sections": false,
+   "sideBar": true,
+   "skip_h1_title": true,
+   "title_cell": "Table of Contents",
+   "title_sidebar": "Contents",
+   "toc_cell": false,
+   "toc_position": {},
+   "toc_section_display": true,
+   "toc_window_display": true
+  },
+  "varInspector": {
+   "cols": {
+    "lenName": 16,
+    "lenType": 16,
+    "lenVar": 40
+   },
+   "kernels_config": {
+    "python": {
+     "delete_cmd_postfix": "",
+     "delete_cmd_prefix": "del ",
+     "library": "var_list.py",
+     "varRefreshCmd": "print(var_dic_list())"
+    },
+    "r": {
+     "delete_cmd_postfix": ") ",
+     "delete_cmd_prefix": "rm(",
+     "library": "var_list.r",
+     "varRefreshCmd": "cat(var_dic_list()) "
+    }
+   },
+   "types_to_exclude": [
+    "module",
+    "function",
+    "builtin_function_or_method",
+    "instance",
+    "_Feature"
+   ],
+   "window_display": false
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

tutorial_template/tutorial_template/.gitignore

+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
\ No newline at end of file