Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #901

Merged
merged 2 commits into from
Jan 9, 2024
Merged

Update documentation #901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44326fd
Update documentation
ebocher Jan 9, 2024
b933840
Update documentation
ebocher Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion bdtopo/src/main/groovy/org/orbisgis/geoclimate/bdtopo/BDTopo.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
*/
package org.orbisgis.geoclimate.bdtopo

import org.orbisgis.geoclimate.utils.LoggerUtils

/**
* Main module for BDTopo processing tasks
*/
Expand Down Expand Up @@ -149,7 +151,7 @@ abstract class BDTopo extends BDTopoUtils {
BDTopoV3Workflow bdTopoV3Workflow = new BDTopoV3Workflow()
return bdTopoV3Workflow.execute(input)
} else {
error "Unsupported version. Set number 2 or 3"
LoggerUtils.error "Unsupported version. Set number 2 or 3"
return null
}
return null
Expand Down
Binary file modified docs/resources/images/geoclimate_implementation.odg
View file
Open in desktop
Binary file not shown.
Binary file modified docs/resources/images/geoclimate_implementation.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/resources/images/geoclimate_main_processing_steps.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/resources/images/geoclimate_processing_grid.png
View file
Open in desktop
Binary file not shown.
176 changes: 176 additions & 0 deletions docs/resources/images/geoclimate_processing_steps.drawio
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<mxfile host="app.diagrams.net" modified="2024-01-09T13:02:02.026Z" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36" etag="4Cu28qSbioyuETKUxTay" version="22.1.17" type="device">
<diagram id="9XxHY0PqiuxusTkwl1Iu" name="Page-1">
<mxGraphModel dx="1964" dy="649" grid="1" gridSize="10" guides="0" tooltips="1" connect="0" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-40" value="" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#CCCCCC;" parent="1" vertex="1">
<mxGeometry x="570" y="359" width="176" height="292" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-21" value="" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#f5f5f5;strokeColor=#666666;fontColor=#333333;" parent="1" vertex="1">
<mxGeometry x="314" y="190" width="176" height="309" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-20" value="" style="rounded=1;whiteSpace=wrap;html=1;strokeColor=#666666;fontColor=#333333;fillColor=#999999;" parent="1" vertex="1">
<mxGeometry x="60" y="278" width="150" height="219" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-26" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-4" target="6Vvcoa5o5CpD2xvE9Xhp-23" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-4" value="Compute&lt;br&gt;Blocks" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="100" y="307" width="80" height="80" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-27" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-5" target="6Vvcoa5o5CpD2xvE9Xhp-24" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-5" value="Compute&lt;br&gt;RSU" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="100" y="397" width="80" height="80" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-12" style="edgeStyle=none;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-6" target="6Vvcoa5o5CpD2xvE9Xhp-4" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-25" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;fillColor=#f5f5f5;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-6" target="6Vvcoa5o5CpD2xvE9Xhp-18" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-6" value="Building layer" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-110" y="327" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-14" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-7" target="6Vvcoa5o5CpD2xvE9Xhp-5" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-28" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;strokeWidth=2;fillColor=#f5f5f5;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-7" target="6Vvcoa5o5CpD2xvE9Xhp-24" edge="1">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="-130" y="407" />
<mxPoint x="-130" y="519" />
<mxPoint x="388" y="519" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-7" value="Road layer" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-110" y="387" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-8" target="6Vvcoa5o5CpD2xvE9Xhp-5" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-35" style="edgeStyle=none;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;strokeColor=#000000;strokeWidth=2;startArrow=none;startFill=0;endArrow=none;endFill=0;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-8" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="-60" y="519" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-8" value="Railway layer" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-110" y="457" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-16" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-9" target="6Vvcoa5o5CpD2xvE9Xhp-5" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-9" value="Vegetation layer" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-110" y="537" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-17" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-10" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="140" y="477" as="targetPoint" />
<Array as="points">
<mxPoint x="-10" y="630" />
<mxPoint x="140" y="630" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-33" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;strokeColor=#000000;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-10" target="6Vvcoa5o5CpD2xvE9Xhp-24" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-10" value="Water layer" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-110" y="608" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-11" value="Impervious layer" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="224" y="690" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-29" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeColor=#000000;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-18" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="457" y="259" as="sourcePoint" />
<mxPoint x="429" y="439" as="targetPoint" />
<Array as="points">
<mxPoint x="449" y="259" />
<mxPoint x="449" y="439" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-18" value="Building" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="349" y="219" width="80" height="80" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-19" value="&lt;b&gt;Spatial units&lt;/b&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="66" y="278" width="80" height="20" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-22" value="&lt;b&gt;Indicators&lt;/b&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="322" y="190" width="80" height="20" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-23" value="Blocks" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="348" y="307" width="80" height="80" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-42" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=1;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;startArrow=none;startFill=0;endArrow=classic;endFill=1;strokeColor=#000000;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-24" target="6Vvcoa5o5CpD2xvE9Xhp-37" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-43" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1.011;exitY=0.482;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;startArrow=none;startFill=0;endArrow=classic;endFill=1;strokeColor=#000000;strokeWidth=2;exitPerimeter=0;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-21" target="6Vvcoa5o5CpD2xvE9Xhp-39" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-24" value="RSU" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="348" y="397" width="80" height="80" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-36" style="edgeStyle=none;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;startArrow=none;startFill=0;endArrow=none;endFill=0;strokeColor=#000000;strokeWidth=2;" parent="1" target="6Vvcoa5o5CpD2xvE9Xhp-23" edge="1">
<mxGeometry relative="1" as="geometry">
<mxPoint x="450" y="347" as="sourcePoint" />
</mxGeometry>
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-31" value="Spatial aggregation" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;rotation=-90;" parent="1" vertex="1">
<mxGeometry x="400" y="339" width="130" height="20" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-37" value="&lt;font style=&quot;font-size: 12px&quot;&gt;&lt;font&gt;Local Climate&lt;br&gt;&lt;/font&gt;zones&lt;/font&gt;" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="613" y="411" width="90" height="92" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-39" value="&lt;font style=&quot;font-size: 12px&quot;&gt;Urban&lt;br&gt;typologies&lt;br&gt;&lt;/font&gt;" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="613" y="529" width="90" height="92" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-41" value="&lt;b&gt;Classification&lt;/b&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="583" y="365.5" width="80" height="20" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-46" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;startArrow=none;startFill=0;endArrow=classic;endFill=1;strokeColor=#000000;strokeWidth=2;" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-44" target="6Vvcoa5o5CpD2xvE9Xhp-24" edge="1">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="260" y="180" />
<mxPoint x="260" y="437" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-44" value="Zone layer" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-110" y="160" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="6Vvcoa5o5CpD2xvE9Xhp-47" value="&lt;b&gt;Data input&lt;/b&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
<mxGeometry x="-150" y="130" width="80" height="20" as="geometry" />
</mxCell>
<mxCell id="a2JpAcOhytjw9-huM3cQ-3" value="Urban areas layer" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="90" y="690" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="a2JpAcOhytjw9-huM3cQ-4" value="Sea/Land areas layer" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="-120" y="690" width="120" height="40" as="geometry" />
</mxCell>
<mxCell id="a2JpAcOhytjw9-huM3cQ-12" style="edgeStyle=none;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeColor=#000000;strokeWidth=2;startArrow=none;startFill=0;endArrow=none;endFill=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="6Vvcoa5o5CpD2xvE9Xhp-10" target="a2JpAcOhytjw9-huM3cQ-4">
<mxGeometry relative="1" as="geometry">
<mxPoint x="-50" y="529" as="targetPoint" />
<mxPoint x="-60" y="670" as="sourcePoint" />
</mxGeometry>
</mxCell>
<mxCell id="a2JpAcOhytjw9-huM3cQ-13" style="edgeStyle=none;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeColor=#000000;strokeWidth=2;startArrow=none;startFill=0;endArrow=none;endFill=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" target="a2JpAcOhytjw9-huM3cQ-3">
<mxGeometry relative="1" as="geometry">
<mxPoint x="-50" y="700" as="targetPoint" />
<mxPoint x="140" y="630" as="sourcePoint" />
</mxGeometry>
</mxCell>
<mxCell id="a2JpAcOhytjw9-huM3cQ-14" style="edgeStyle=none;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeColor=#000000;strokeWidth=2;startArrow=none;startFill=0;endArrow=none;endFill=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" target="6Vvcoa5o5CpD2xvE9Xhp-11">
<mxGeometry relative="1" as="geometry">
<mxPoint x="274" y="689" as="targetPoint" />
<mxPoint x="274" y="669" as="sourcePoint" />
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Loading
Loading