mkdocs.yml

site_name: SimPaths Documentation
site_description: >-
  An open-source microsimulation framework for modelling individual
  and household life course events across the UK and Europe.
site_url: https://simpaths.github.io/SimPaths/
repo_url: https://github.com/simpaths/SimPaths
repo_name: simpaths/SimPaths

docs_dir: documentation/wiki

copyright: >-
  Copyright © Matteo Richiardi, Patryk Bronka, Justin van de Ven —
  Centre for Microsimulation and Policy Analysis

theme:
  name: material
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font: false
  logo: assets/images/logo.svg
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate

extra_css:
  - assets/css/extra.css

plugins:
  - search:
      lang: en

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      toc_depth: 3
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - def_list

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/simpaths/SimPaths
      name: GitHub
    - icon: fontawesome/solid/globe
      link: https://www.microsimulation.ac.uk/
      name: Centre for Microsimulation and Policy Analysis

nav:
  - Home: index.md

  - Overview:
      - overview/index.md
      - Model Description: overview/model-description.md
      - Simulated Modules: overview/simulated-modules.md
      - Model Parameterisation: overview/parameterisation.md
      - Country Variants: overview/country-variants.md
      - How to Cite: overview/how-to-cite.md

  - Getting Started:
      - getting-started/index.md
      - Environment Setup: getting-started/environment-setup.md
      - Input Data:
          - getting-started/data/index.md
          - Initial Population (UK): getting-started/data/initial-population-uk.md
          - Tax-Benefit Donors (UK): getting-started/data/tax-benefit-donors-uk.md
      - Running Your First Simulation: getting-started/first-simulation.md
      - Video Tutorials: getting-started/video-tutorials.md

  - User Guide:
      - user-guide/index.md
      - Single Runs: user-guide/single-runs.md
      - Multiple Runs: user-guide/multiple-runs.md
      - Graphical User Interface: user-guide/gui.md
      - Modifying Tax-Benefit Settings: user-guide/tax-benefit-parameters.md
      - Uncertainty Analysis: user-guide/uncertainty-analysis.md

  - Developer Guide:
      - developer-guide/index.md
      - Working in GitHub: developer-guide/working-in-github.md
      - Repository Guide: developer-guide/repository-guide.md
      - JAS-mine Architecture:
          - developer-guide/jasmine/index.md
          - Project Structure: developer-guide/jasmine/project-structure.md
          - The Model and the Schedule: developer-guide/jasmine/model-and-schedule.md
          - The Start Class: developer-guide/jasmine/start-class.md
          - The MultiRun Class: developer-guide/jasmine/multirun-class.md
          - Updating JAS-mine: developer-guide/jasmine/updating-jasmine.md
      - SimPaths Internals:
          - developer-guide/internals/index.md
          - SimPaths API: developer-guide/internals/api.md
          - The SimPathsModel Class: developer-guide/internals/simpaths-model.md
          - Start Class Implementation: developer-guide/internals/start-class-implementation.md
          - MultiRun Implementation: developer-guide/internals/multirun-implementation.md
      - How-To Guides:
          - developer-guide/how-to/index.md
          - Introduce a New Variable: developer-guide/how-to/new-variable.md
          - Add Parameters to the GUI: developer-guide/how-to/add-gui-parameters.md
          - Perform MultiRun Simulations: developer-guide/how-to/multirun-simulations.md
      - JAS-mine Reference:
          - jasmine-reference/index.md
          - Statistical Package: jasmine-reference/statistical-package.md
          - Collection Filters: jasmine-reference/collection-filters.md
          - Alignment Library: jasmine-reference/alignment-library.md
          - Matching Library: jasmine-reference/matching-library.md
          - Regression Library: jasmine-reference/regression-library.md
          - Saving Outputs: jasmine-reference/saving-outputs.md
          - Querying the Database: jasmine-reference/querying-database.md
          - Links and Resources: jasmine-reference/links.md
          - Enums: jasmine-reference/enums.md

  - Model Validation:
      - validation/index.md

  - Research:
      - research/index.md