diff --git a/docs/assets/images/hf-logo.svg b/docs/assets/images/hf-logo.svg new file mode 100644 index 0000000..ab959d1 --- /dev/null +++ b/docs/assets/images/hf-logo.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/datasets.md b/docs/datasets.md index 7f0f04f..8fcbae7 100644 --- a/docs/datasets.md +++ b/docs/datasets.md @@ -1,4 +1,18 @@ -!!! info - Page under construction +# PLAID Datasets Overview + +At the heart of PLAID is the seemless exchange of dataset for streamlined collaboration. Corresponding datasets are provided at [HuggingFace](https://huggingface.co/PLAID-datasets) and in a [Zenodo community](https://zenodo.org/communities/plaid_datasets). + +[PLAID‑datasets](https://huggingface.co/PLAID-datasets) is a curated collection of physics‑based datasets formatted with the **PLAID** data model. Each dataset represents a computational physics or structural mechanics problem defined on unstructured meshes and is suitable for **graph machine‑learning** applications. The datasets contain mesh data together with scalar and field quantities (e.g., pressure, displacement and turbulence variables) and come with predefined train/test splits to support machine‑learning tasks. They were all generated using the PLAID library and datamodel and are released under open licences. See also [PLAID's official documentation](https://plaid-lib.readthedocs.io/en/stable/source/plaid_benchmarks.html#) for more information. + +
+- HF [__AirfRANS (remeshed)__](https://huggingface.co/datasets/PLAID-datasets/AirfRANS_remeshed) +- HF [__AirfRANS (original)__](https://huggingface.co/datasets/PLAID-datasets/AirfRANS_original) +- HF [__AirfRANS (clipped)__](https://huggingface.co/datasets/PLAID-datasets/AirfRANS_clipped) +- HF [__VKI-LS59__](https://huggingface.co/datasets/PLAID-datasets/VKI-LS59) +- HF [__Tensile2d__](https://huggingface.co/datasets/PLAID-datasets/Tensile2d) +- HF [__Rotor37__](https://huggingface.co/datasets/PLAID-datasets/Rotor37) +- HF [__2D Mutiscale Hyperelasticity__](https://huggingface.co/datasets/PLAID-datasets/2D_Multiscale_Hyperelasticity) +- HF [__2D_profile__](https://huggingface.co/datasets/PLAID-datasets/2D_profile) +- HF [__2D ElastoPlastoDynamics__](https://huggingface.co/datasets/PLAID-datasets/2D_ElastoPlastoDynamics) +
-At the heart of PLAID is the seemless exchange of dataset for streamlined collaboration. Corresponding datasets are provided in [HuggingFace](https://huggingface.co/PLAID-datasets) as well, and in a [Zenodo community](https://zenodo.org/communities/plaid_datasets). diff --git a/mkdocs.yml b/mkdocs.yml index f091fe4..3380723 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,9 +52,45 @@ plugins: markdown_extensions: - admonition - - pymdownx.highlight + - attr_list + - def_list + - footnotes + - md_in_html + - meta + - sane_lists # lists separated by paragraphs + - toc: + permalink: true + - pymdownx.arithmatex: + generic: true + - pymdownx.blocks.admonition + - pymdownx.betterem: + smart_enable: all + - pymdownx.caret + - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true - pymdownx.inlinehilite - - pymdownx.superfences + - pymdownx.keys + - pymdownx.magiclink + - pymdownx.mark + - pymdownx.smartsymbols + - pymdownx.superfences: + custom_fences: + - class: mermaid + name: mermaid + - pymdownx.tabbed: + alternate_style: true + - pymdownx.blocks.tab: + alternate_style: true + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + - mkdocs-click nav: - Project: index.md diff --git a/pyproject.toml b/pyproject.toml index 49769ba..124b3fd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -10,6 +10,7 @@ requires-python = ">=3.10,<3.13" dependencies = [ "htmlmin2>=0.1.13,<0.2", "mkdocs>=1.6.1", + "mkdocs-click>=0.9.0", "mkdocs-gen-files>=0.5.0", "mkdocs-include-markdown-plugin>=7.1.6", "mkdocs-literate-nav>=0.6.2",