forked from allfed/Seaweed-Scaleup-Model
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkgendocs.yml
36 lines (30 loc) · 812 Bytes
/
mkgendocs.yml
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
site_name: Seaweed Upscaling Model
# Repository
repo_name: Seaweed Upscaling Model
repo: https://github.com/allfed/Seaweed-Upscaling-Model
# Copyright
copyright: ALLFED
#This specifies the autogeneration portion
pages:
- page: "modules/src/scaleup_model.md"
source: "src/scaleup_model.py"
classes:
- SeaweedScaleUpModel
functions:
- self_shading
- calculate_seaweed_need
- seaweed_farm_area_per_day
- logistic_curve
- run_model
- page: "modules/src/preprocessing.md"
source: "src/preprocessing.py"
functions:
- prep_data
- page: "modules/src/plotter.md"
source: "src/plotter.py"
functions:
- plot_satisfaction_results
- plot_scenario_comparison
- plot_area_results
- plot_self_shading
- create_plots