nomad-perovskite-solar-cells-database/mkdocs.yml at main · FAIRmat-NFDI/nomad-perovskite-solar-cells-database · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
site_name: nomad-perovskite-solar-cells-database
site_description: This is a NOMAD plugin for the perovskite solar cells database.
edit_uri: ""
repo_url: https://github.com/FAIRmat-NFDI/nomad-perovskite-solar-cells-database

nav:
  - Home: index.md
  - Tutorial:
      - tutorial/index.md
      - Sharing a Perovskite Composition: tutorial/sharing_a_perovskite_composition.md
      - Notebooks:
          - Query the Perovskite Database: notebooks/perla_notebooks/query-perovskite-database.ipynb
          - Query the Ion Database: notebooks/ions_database/query-ion-database-api.ipynb
          - Query Perovskite Compositions: notebooks/ions_database/query-perovskite-composition.ipynb
          - Build Perovskite Structures from Ions: notebooks/ions_database/build-perovskite-structure-from-ion-entry.ipynb
          - Architecture Evolution Analysis: notebooks/perla_notebooks/architecture-evolution.ipynb
          - Bandgap Evolution Analysis: notebooks/perla_notebooks/bandgap-evolution.ipynb
          - Performance Evolution Analysis: notebooks/perla_notebooks/performance-evolution.ipynb
          - Diversity Evolution Analysis: notebooks/perla_notebooks/diversity-analysis.ipynb
          - PerovScribe Analysis: notebooks/perla_notebooks/perovscribe-analysis.ipynb
          - Perovskite Paperbot Plotting: notebooks/perla_notebooks/perovskite-paperbot-plot.ipynb
          - CrabNet Bandgap Prediction: notebooks/perla_notebooks/crabnet-perovskite-bandgap-prediction.ipynb
          - ML Distribution Shift Case Study: notebooks/perla_notebooks/ml-distribution-shift-case-study.ipynb
  - How-to guides:
      - Install this plugin: how_to/install_this_plugin.md
      - Explore the databases: how_to/explore_the_databases.md
      - Create a perovskite compostion: how_to/create_a_perovskite_composition.md
      - Add a new ion: how_to/add_a_new_ion.md
      - Export a structure: how_to/export_structures.md
      - Download data: how_to/download_data.md
  - Reference:
      - Composition and ion schema: reference/composition_and_ion_schema.md
      - Solar cells schema: reference/solar_cell_schema.md
      - Tandem schema: reference/tandem_schema.md
plugins:
  - search
  - glightbox
  - mkdocs-jupyter:
      ignore_h1_titles: true
      include_source: true
      execute: false
      allow_errors: false
  - macros:
      module_name: docs/main

theme:
  name: material
  palette:
    primary: "#2A4CDF"
    accent: "#008A67"
  font:
    text: "Titillium Web"
  logo: assets/nomad-plugin-logo.png
  favicon: assets/favicon.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.path
    - navigation.footer
    - navigation.top
    - toc.follow
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
  custom_dir: docs/theme
markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - mkdocs-click
  - pymdownx.extra
  - toc:
      permalink: True
  - pymdownx.arithmatex:
      generic: true

extra:
  generator: false
  homepage: https://github.com/FAIRmat-NFDI/nomad-perovskite-solar-cells-database
use_directory_urls: false
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js
  - javascript.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - https://cdnjs.cloudflare.com/ajax/libs/plotly.js/2.24.1/plotly.min.js