_toc.yml

# Table of contents
# Learn more at https://jupyterbook.org/customize/toc.html

# The table of contents needs to be at the root level of the package because it is not possible to
# define relative parent folders within this table of contents file.

format: jb-book
root: README.md

options: # The options key will be applied to all chapters, but not sub-sections
  numbered: True

parts:
  - caption: Examples
    maxdepth: 3
    chapters:
      # - caption: Overview
      - file: docs/example_articles/0_example_overview.md
      # - caption: Download Weather Data
      - file: docs/example_articles/1_download_input_data.md
        sections:
          - file: examples/1_load_input_data/1_1_1_how_to_download_era5_data.ipynb
          - file: examples/1_load_input_data/1_1_2_wind_speed_from_vectors_in_era5.ipynb
          - file: examples/1_load_input_data/1_2_1_reading_merra_weather_data.ipynb
          - file: examples/1_load_input_data/1_2_2_vertically_project_wind_speed_from_merra.ipynb
          - file: examples/1_load_input_data/1_3_1_process_power_curves_from_thewindpower_net.ipynb
      # - caption: Evaluate Economics
      - file: docs/example_articles/2_evaluate_economics.md
        sections:
          - file: examples/2_economic/2_1_economic_compute_levelized_cost_of_electricity.ipynb
      - file: docs/example_articles/3_wind_power.md
        sections:
          - file: examples/3_wind/3_1_wind_workflows_overview.ipynb
          - file: examples/3_wind/3_2_1_wind_load_power_curve.ipynb
          - file: examples/3_wind/3_2_2_wind_synthetic_power_curve.ipynb
          - file: examples/3_wind/3_3_wind_convolute_a_power_curve.ipynb
          - file: examples/3_wind/3_4_wind_design_onshore_turbine.ipynb
          - file: examples/3_wind/3_5_wind_estimate_turbine_capital_cost.ipynb
          - file: examples/3_wind/3_6_1_wind_basic_turbine_simulation.ipynb
          - file: examples/3_wind/3_6_2_wind_turbine_simulation_workflow.ipynb
          - file: examples/3_wind/3_6_3_wind_automated_turbine_simulation_workflow.ipynb
          - file: examples/3_wind/3_7_example_ethos_reskit_wind_workflow.ipynb
      - file: docs/example_articles/4_solar.md
        sections:
          - file: examples/4_solar/4_1_solar_workflows_overview.ipynb
          - file: examples/4_solar/4_2_check_available_pv_modules.ipynb
          - file: examples/4_solar/4_3_solar_automated_simulation_workflow.ipynb
      - file: docs/example_articles/5_geothermal.md
        sections:
          - file: examples/5_geothermal/5_run_geothermal_simulations.ipynb
      - file: docs/example_articles/6_direct_air_capture.md
        sections:
          - file: examples/6_direct_air_capture/6_1_direct_air_capture.ipynb
          - file: examples/6_direct_air_capture/6_2_cooling_heating.ipynb

  - caption: API
    chapters:
      # The API documentation is written to the folder
      - file: _readthedocs/reskit/index.rst
  - caption: Code of Conduct
    chapters:
      # The API documentation is written to the folder
      - file: docs/CODE_OF_CONDUCT.md