-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
34 changed files
with
834 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: 7932d083f9a06fd5b7a85bfbbdbae04b | ||
| config: 749b8690b74b37f941c919029c99e5e5 | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"cells": [{"cell_type": "markdown", "id": "b17cc207-0f09-4783-bc8b-271c9ffc4fdb", "metadata": {}, "source": ["# Title of user example\n", "\n", "**short description: what can be learned from this example?**"]}, {"cell_type": "markdown", "id": "d45589a1-6db7-4ea9-856b-4471b7cb2f55", "metadata": {}, "source": ["A longer description of what this example is about."]}, {"cell_type": "markdown", "id": "b9fdba5b-a01b-4849-b3ce-79d938be2525", "metadata": {}, "source": ["## The data\n", "\n", "| **Data file** | **Type** | **Download** | **Courtesy of** | **Reference** |\n", "| :- | :- | :- | :-: | :-: |\n", "| filename | Raw/Reconstruction etc. | [Link to download]() | Who to credit for providing the data | [DOI]() |\n", "\n", "Add a more detailed description of the data here, i.e. dimensions, meta parameters etc. "]}, {"cell_type": "markdown", "id": "bd29eb2c-6c2e-4a19-87a1-a4cac57f4fd5", "metadata": {}, "source": ["## Main body of tutorial\n", "\n", "Anything that adds value to this user example, i.e. background theory, highlighting certain parameters, explaining methods or pipelines, discussing challenges etc.\n", "\n", "You can use the MyST makrdown syntax, check this [cheatsheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html) as a reference."]}, {"cell_type": "markdown", "id": "da74020a-6ead-4389-af38-94433bc44235", "metadata": {}, "source": ["## Admonitions\n", "\n", "The MyST syntax comes with [admonitions](https://jupyterbook.org/en/stable/reference/cheatsheet.html#admonitions) which can be useful to highlight certain things and give hints to users. \n", "To also render those admonitions nicely in plain jupyter notebooks, please use on of the following templates below. They use HTML which also renders in Jupyter notebooks, but when published they are converted to MyST admonitions by the Github actions pipeline."]}, {"cell_type": "markdown", "id": "13f8b2d2-ddb4-41a3-89ef-fdce4e470f77", "metadata": {}, "source": ["`````{admonition} Tip \n", ":class: tip\n", "Something useful</a>\n", "`````"]}, {"cell_type": "markdown", "id": "3a4b8a4d-c042-44a7-98ac-009dbe9ae2f8", "metadata": {}, "source": ["`````{admonition} Note \n", ":class: note\n", "A note with \n", "```python\nsome code\n", "```\n", "inside and <code>more code</code> inline.\n", "`````"]}, {"cell_type": "markdown", "id": "1e7d8f70-db57-4f46-acdf-2568dd116d03", "metadata": {}, "source": ["`````{admonition} Challenge \n", ":class: attention\n", "Provide some ideas for playing with and exploring this examples. \n", "`````"]}, {"cell_type": "markdown", "id": "45fe49ce-ba50-49f4-9404-cac09ea94817", "metadata": {}, "source": ["`````{admonition} Tip \n", ":class: tip\n", "Give some hints on how to get started with.\n", "`````"]}, {"cell_type": "markdown", "id": "9bed971f-2ac9-4ba0-94d6-b14e0dc0d442", "metadata": {}, "source": ["## Images\n", "\n", "For displaying any images, just upload into the _assets folder and then use \n", "\n", "``````\n", "\n", ""]}, {"cell_type": "markdown", "id": "7d4f0e99-2943-4e0e-bbcf-2cf342f0d167", "metadata": {}, "source": ["---"]}, {"cell_type": "code", "execution_count": null, "id": "1d7891fd-e0a0-4459-afac-43a68d1f5c22", "metadata": {"tags": []}, "outputs": [], "source": ["# Add full code of PtyPy run script here\n", "# ..."]}], "metadata": {"kernelspec": {"display_name": "PtyPy (cupy)", "language": "python", "name": "ptypy_cupy"}, "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.11.8"}}, "nbformat": 4, "nbformat_minor": 5} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.