mkdocs.yml

site_name: stemflow
site_description: 'A package for Adaptive Spatio-Temporal Model (AdaSTEM) in python.'
repo_name: 'chenyangkang/stemflow'
repo_url: 'https://github.com/chenyangkang/stemflow'
site_url: https://chenyangkag.github.io/stemflow/
use_directory_urls: false

theme:
  name: material
  icon:
      repo: 'fontawesome/brands/github'
  features:
    - toc.follow
    # - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - search.share
    - navigation.indexes



  language: en

  palette:
    # Palette toggle for light mode
    - scheme: default
      accent: light green
      primary: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      accent: light green
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: Roboto
  logo: assets/logo.png
  favicon: assets/logo.png

plugins:
  - social
  - mkdocs-jupyter
  - mkdocstrings:
      handlers:
        python:
          options:
            # inherited_members: true
            docstring_style: google
            docstring_section_style: list
            # show_object_full_path: true
            # show_root_full_path: true

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/chenyangkang
    # - icon: fontawesome/brands/twitter
    #   link: https://twitter.com/TheJamesWillett
    # - icon: fontawesome/brands/linkedin
    #   link: https://www.linkedin.com/in/willettjames/
  analytics:
    provider: google
    property: G-LT28RB77G3


nav:
  - Home: index.md
  - 'A Brief Introduction': A_brief_introduction/A_brief_introduction.md
  - Examples:
    - 'AdaSTEM demo': Examples/01.AdaSTEM_demo.ipynb
    - 'SphereAdaSTEM demo': Examples/04.SphereAdaSTEM_demo.ipynb
    - 'Learning curve analysis': Examples/02.AdaSTEM_learning_curve_analysis.ipynb
    - 'Maxent as base model': Examples/03.Binding_with_Maxent.ipynb
    - 'Using hurdle model in AdaSTEM': Examples/05.Hurdle_in_ada_or_ada_in_hurdle.ipynb
    - 'Base model choices': Examples/06.Base_model_choices.ipynb
    - 'Optimizing stixel size': Examples/07.Optimizing_stixel_size.ipynb
    - 'Lazy-loading': Examples/08.Lazy_loading.ipynb
  - Tips:
    - 'Tips for spatiotemporal indexing': Tips/Tips_for_spatiotemporal_indexing.md
    - 'Tips for data types': Tips/Tips_for_data_types.md
    - 'Tips for different tasks': Tips/Tips_for_different_tasks.md
  - API Documentation:
    - stemflow.model:
      - 'AdaSTEM': API_Documentation/model/stemflow.model.AdaSTEM.md
      - 'SphereAdaSTEM': API_Documentation/model/stemflow.model.SphereAdaSTEM.md
      - 'STEM': API_Documentation/model/stemflow.model.STEM.md
      - 'static_func_AdaSTEM': API_Documentation/model/stemflow.model.static_func_AdaSTEM.md
      - 'Hurdle': API_Documentation/model/stemflow.model.Hurdle.md
      - 'dummy_model': API_Documentation/model/stemflow.model.dummy_model.md
      - 'special_hurdle': API_Documentation/model/stemflow.model.special_hurdle.md
    - stemflow.gridding:
      - 'Q_blocks': API_Documentation/gridding/stemflow.gridding.Q_blocks.md
      - 'QTree': API_Documentation/gridding/stemflow.gridding.QTree.md
      - 'Sphere_QTree': API_Documentation/gridding/stemflow.gridding.Sphere_QTree.md
      - 'QuadGrid': API_Documentation/gridding/stemflow.gridding.QuadGrid.md
    - stemflow.utils:
      - 'jitterrotation':
        - 'jitterrotator': API_Documentation/utils/jitterrotation/stemflow.utils.jitterrotation.jitterrotator.md
      - 'sphere':
        - 'coordinate_transform': API_Documentation/utils/sphere/stemflow.utils.sphere.coordinate_transform.md
        - 'discriminant_formula': API_Documentation/utils/sphere/stemflow.utils.sphere.discriminant_formula.md
        - 'distance': API_Documentation/utils/sphere/stemflow.utils.sphere.distance.md
        - 'Icosahedron': API_Documentation/utils/sphere/stemflow.utils.sphere.Icosahedron.md
      - 'quadtree': API_Documentation/utils/stemflow.utils.quadtree.md
      - 'sphere_quadtree': API_Documentation/utils/stemflow.utils.sphere_quadtree.md
      - 'plot_gif': API_Documentation/utils/stemflow.utils.plot_gif.md
      - 'generate_soft_colors': API_Documentation/utils/stemflow.utils.generate_soft_colors.md
      - 'validation': API_Documentation/utils/stemflow.utils.validation.md
      - 'wrapper': API_Documentation/utils/stemflow.utils.wrapper.md
      - 'lazyloading': API_Documentation/utils/stemflow.utils.lazyloading.md
    - stemflow.model_selection: API_Documentation/stemflow.model_selection.md

  - Fun Visualization:
    - 'Global Bird Diversity': Fun_Visualization/Global_Bird_Shannon_H_Index.md
    - 'Ruby-crowned_Kinglet': Fun_Visualization/Ruby-crowned_Kinglet_2020.md
    - 'Global NDVI': Fun_Visualization/Global_NDVI.md
    - 'Global Mean Temperature': Fun_Visualization/Global_Mean_Temperature_2020.md
  - Contributing: CONTRIBUTING.md
  - 'Code of conduct': CODE_OF_CONDUCT.md

  # - Download mini data: mini_data/mini_data.csv

markdown_extensions:
  - tables
  # - toc:
  #     toc_depth : "1-1"
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji
      # emoji_index: !!python/name:materialx.emoji.twemoji
      # emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.tilde

# extra_css:
#   - css/extra.css


copyright: |
  &copy; 2024 <a href="https://github.com/chenyangkang"  target="_blank" rel="noopener">Yangkang Chen</a>