_pkgdown.yml

url: https://hongyuanjia.github.io/eplusr

authors:
  Hongyuan Jia:
    href: https://github.com/hongyuanjia

template:
  params:
    docsearch:
      api_key: "158ff4599f27d2efdd371e5200cdb538"
      index_name: "eplusr"
    ganalytics: UA-141601756-1

development:
  model: auto

navbar:
  structure:
    left:  [home, intro, slides, articles, reference, news]
    right: [github]
  components:
    home:
      icon: fas fa-home fa-lg
      href: index.html
    intro:
      text: "Get started"
      href: articles/eplusr.html
    articles:
      text: Vignettes
      menu:
      - text: "Introduction to eplusr"
        href: articles/eplusr.html
      - text: "Run simulation and data exploration"
        href: articles/job.html
      - text: "Parametric simulations"
        href: articles/param.html
      - text: "Update IDF version"
        href: articles/transition.html
      - text: "Work with weather files"
        href: articles/epw.html
      - text: "Work with `Schedule:Compact` objects"
        href: articles/schedule.html
      - text: "Work with geometries"
        href: articles/geom.html
      - text: "Frequently asked questions"
        href: articles/faq.html
    reference:
      text: Manual
      href: reference/index.html
    news:
      text: News
      href: news/index.html
    github:
      icon: fa-github fa-lg
      href: https://github.com/hongyuanjia/eplusr

reference:
  - title: IDD
    desc: Use a specific EnergyPlus Input Data Dictionary (IDD)
    contents:
      - Idd
      - IddObject
      - idd_object
      - use_idd
      - download_idd
      - avail_idd
      - is_avail_idd
      - as.character.IddObject
      - format.Idd
      - format.IddObject

  - title: IDF
    desc: Read, modify and run an EnergyPlus Input Data File (IDF)
    contents:
      - Idf
      - IdfObject
      - idf_object
      - read_idf
      - empty_idf
      - transition
      - version_updater
      - as.character.Idf
      - as.character.IdfObject
      - format.Idf
      - format.IdfObject

  - title: IDF schedules
    desc: Class for IDF `Schedule:Compact` objects
    contents:
      - IdfScheduleCompact
      - schedule_compact

  - title: IDF geometry
    desc: Classes for IDF geometry
    contents:
      - IdfGeometry
      - IdfViewer
      - idf_geometry
      - idf_viewer

  - title: EPW
    desc: Download, read and modify an EnergyPlus Weather (EPW)
    contents:
      - Epw
      - read_epw
      - download_weather

  - title: Configure EnergyPlus
    contents:
      - install_eplus
      - uninstall_eplus
      - download_eplus
      - use_eplus
      - eplus_config
      - avail_eplus
      - locate_eplus
      - is_avail_eplus
      - path_eplus
      - path_eplus_processor
      - path_eplus_example
      - path_eplus_weather
      - path_eplus_dataset

  - title: Job
    desc: Run EnergyPlus and collect outputs
    contents:
      - EplusSql
      - EplusJob
      - EplusGroupJob
      - ParametricJob
      - eplus_sql
      - eplus_job
      - group_job
      - param_job
      - run_idf
      - run_multi
      - clean_wd
      - read_err
      - read_rdd
      - read_mdd
      - print.ErrFile
      - print.TransitionErrFile

  - title: Data Helpers
    desc: Help to create and format IDF data
    contents:
      - dt_to_load
      - rdd_to_load
      - mdd_to_load
      - reload

  - title: Assertion
    desc: Check Types
    contents:
      - is_idd
      - is_idf
      - is_iddobject
      - is_idfobject
      - is_epw
      - is_idd_ver
      - is_eplus_ver
      - is_eplus_path

  - title: eplusr Options
    contents:
      - eplusr-package
      - eplusr_option
      - custom_validate
      - level_checks
      - with_option
      - with_silent
      - without_checking