Skip to content

39.2 documentation improvements #74

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

Open
martin-rdz wants to merge 5 commits into
base: main
Choose a base branch
from
Open

39.2 documentation improvements #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bd96038
fixing quotation marks (#39)
martin-rdz May 11, 2026
1270913
better descripttion of the configs
martin-rdz May 12, 2026
77c77d3
add the tables with the config file entries #39
martin-rdz May 12, 2026
c420cc4
further filled the config files table #39
martin-rdz May 13, 2026
20ffbdc
wrote a small piece on the structure of the data_cube #39
martin-rdz May 13, 2026
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
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,8 @@ docs/source/_autosummary/*
tests/*.png
tests/plots/*.png
tests/test_case_data/*.nc

docs/source/picasso_config_keys.csv
docs/source/polly_config_keys.csv


2 changes: 2 additions & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,6 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
cp ../README.md "$(SOURCEDIR)"
cp ../ppcpy/config/polly_config_keys.csv "$(SOURCEDIR)"
cp ../ppcpy/config/picasso_config_keys.csv "$(SOURCEDIR)"
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
4 changes: 3 additions & 1 deletion docs/source/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ python3 tests\picassopy_testing.py --picasso_config_file "pollynet_processing_ch
```

### Contribute
Your contribution is welcomed! Just have a look into the issue, some of them are quite easy to fix or file one yourself detailing a bug you found.
Additions to the documentation or tests is also always encouraged. Also, if you want to contribute more sophisticated algorithms feel free to file a pull request.

### History

### License
GNU GPL (see LICENSE)
GNU GPL (see LICENSE)
146 changes: 146 additions & 0 deletions docs/source/userguide/PicassoPy_config_overview.drawio
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
<mxfile host="65bd71144e" scale="4" border="0">
<diagram id="6R6sbf5CsMhxrPgUaiNa" name="Page-1">
<mxGraphModel dx="927" dy="780" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0"/>
<mxCell id="1" parent="0"/>
<mxCell id="2" value="&lt;div&gt;&lt;b&gt;&lt;font style=&quot;font-size: 14px;&quot;&gt;specific picasso_config_file&lt;/font&gt;&lt;/b&gt;&lt;/div&gt;pollynet_processing_chain_config_test.json" style="shape=document;whiteSpace=wrap;html=1;boundedLbl=1;align=left;size=0.20544607979910715;" vertex="1" parent="1">
<mxGeometry x="40" y="122" width="290" height="60" as="geometry"/>
</mxCell>
<mxCell id="5" value="&lt;div&gt;&lt;span style=&quot;font-size: 14px;&quot;&gt;&lt;b&gt;picasso_default_config_file [template]&lt;/b&gt;&lt;/span&gt;&lt;/div&gt;ppcpy/config/pollynet_processing_chain_config.json" style="shape=document;whiteSpace=wrap;html=1;boundedLbl=1;align=left;size=0.20544607979910715;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" vertex="1" parent="1">
<mxGeometry x="40" y="40" width="290" height="60" as="geometry"/>
</mxCell>
<mxCell id="7" value="&lt;font style=&quot;color: rgb(0, 0, 0);&quot;&gt;update template&lt;br&gt;with specific config&lt;/font&gt;&lt;div&gt;&lt;font face=&quot;Lucida Console&quot; style=&quot;color: rgb(0, 0, 0); font-size: 10px;&quot;&gt;loadPicassoConfig()&lt;/font&gt;&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="358" y="107" width="120" height="60" as="geometry"/>
</mxCell>
<mxCell id="9" value="" style="edgeStyle=elbowEdgeStyle;elbow=vertical;endArrow=blockThin;html=1;curved=0;rounded=0;endSize=8;startSize=8;exitX=1;exitY=0.25;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="5" target="7">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="400" y="100" as="sourcePoint"/>
<mxPoint x="450" y="50" as="targetPoint"/>
<Array as="points">
<mxPoint x="377" y="54"/>
</Array>
</mxGeometry>
</mxCell>
<mxCell id="10" value="" style="endArrow=blockThin;html=1;exitX=1;exitY=0.25;exitDx=0;exitDy=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="2" target="7">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="400" y="100" as="sourcePoint"/>
<mxPoint x="450" y="50" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="11" value="picasso_config_dict" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;fillColor=#cce5ff;strokeColor=#36393d;" vertex="1" parent="1">
<mxGeometry x="330" y="198" width="177" height="30" as="geometry"/>
</mxCell>
<mxCell id="12" value="" style="endArrow=blockThin;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="7" target="11">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="340" y="148" as="sourcePoint"/>
<mxPoint x="368" y="147" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="13" value="&lt;div&gt;date&lt;/div&gt;" style="ellipse;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="40" y="350" width="70" height="40" as="geometry"/>
</mxCell>
<mxCell id="14" value="system" style="ellipse;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="40" y="290" width="70" height="40" as="geometry"/>
</mxCell>
<mxCell id="16" value="" style="edgeStyle=elbowEdgeStyle;elbow=horizontal;endArrow=blockThin;html=1;curved=0;rounded=0;endSize=8;startSize=8;exitX=0.375;exitY=1;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="11" target="3">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="400" y="100" as="sourcePoint"/>
<mxPoint x="450" y="50" as="targetPoint"/>
<Array as="points">
<mxPoint x="396" y="240"/>
</Array>
</mxGeometry>
</mxCell>
<mxCell id="17" value="get the time-dependent config&lt;br&gt;&lt;div&gt;&lt;font face=&quot;Lucida Console&quot; style=&quot;color: rgb(0, 0, 0); font-size: 10px;&quot;&gt;readPollyNetConfigLinkTable()&lt;/font&gt;&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="145" y="310" width="180" height="50" as="geometry"/>
</mxCell>
<mxCell id="18" value="" style="endArrow=blockThin;html=1;exitX=0.75;exitY=0;exitDx=0;exitDy=0;entryX=0.25;entryY=0;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="3" target="17">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="428" y="177" as="sourcePoint"/>
<mxPoint x="429" y="220" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="3" value="&lt;div style=&quot;scrollbar-color: rgb(226, 226, 226) rgb(251, 251, 251);&quot;&gt;&lt;b style=&quot;scrollbar-color: rgb(226, 226, 226) rgb(251, 251, 251);&quot;&gt;&lt;font style=&quot;scrollbar-color: rgb(226, 226, 226) rgb(251, 251, 251); font-size: 14px; color: rgb(0, 0, 0);&quot;&gt;pollynet_config_link_file&lt;/font&gt;&lt;/b&gt;&lt;/div&gt;&lt;div&gt;&lt;font style=&quot;color: rgb(0, 0, 0);&quot;&gt;[xlsx, csv]&lt;/font&gt;&lt;/div&gt;" style="shape=document;whiteSpace=wrap;html=1;boundedLbl=1;align=left;size=0.174072265625;" vertex="1" parent="1">
<mxGeometry x="40" y="210" width="200" height="70" as="geometry"/>
</mxCell>
<mxCell id="19" value="" style="edgeStyle=elbowEdgeStyle;elbow=horizontal;endArrow=blockThin;html=1;curved=0;rounded=0;endSize=8;startSize=8;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.75;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="13" target="17">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="406" y="250" as="sourcePoint"/>
<mxPoint x="250" y="255" as="targetPoint"/>
<Array as="points">
<mxPoint x="121" y="362"/>
</Array>
</mxGeometry>
</mxCell>
<mxCell id="20" value="" style="edgeStyle=elbowEdgeStyle;elbow=horizontal;endArrow=blockThin;html=1;curved=0;rounded=0;endSize=8;startSize=8;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0;entryY=0.25;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="14" target="17">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="120" y="380" as="sourcePoint"/>
<mxPoint x="155" y="365" as="targetPoint"/>
<Array as="points">
<mxPoint x="121" y="323"/>
</Array>
</mxGeometry>
</mxCell>
<mxCell id="21" value="polly_config_array" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;fillColor=#cce5ff;strokeColor=#36393d;" vertex="1" parent="1">
<mxGeometry x="102" y="408" width="177" height="30" as="geometry"/>
</mxCell>
<mxCell id="22" value="" style="endArrow=blockThin;html=1;exitX=0.25;exitY=1;exitDx=0;exitDy=0;strokeWidth=3;endFill=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="17" target="21">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="200" y="380" as="sourcePoint"/>
<mxPoint x="190" y="400" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="23" value="load + combine the polly&lt;br&gt;specific config&lt;br&gt;&lt;div&gt;&lt;font face=&quot;Lucida Console&quot; style=&quot;color: rgb(0, 0, 0); font-size: 10px;&quot;&gt;getPollyConfigfromArray()&lt;/font&gt;&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="307" y="410" width="180" height="50" as="geometry"/>
</mxCell>
<mxCell id="25" value="" style="endArrow=blockThin;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;exitX=0.375;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="11" target="23">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="380" y="260" as="sourcePoint"/>
<mxPoint x="200" y="320" as="targetPoint"/>
</mxGeometry>
</mxCell>
<mxCell id="26" value="&lt;div&gt;&lt;b&gt;&lt;font style=&quot;font-size: 14px;&quot;&gt;specific polly_config_file&lt;/font&gt;&lt;/b&gt;&lt;/div&gt;pollyxt_cpv_config_20230927.json" style="shape=document;whiteSpace=wrap;html=1;boundedLbl=1;align=left;size=0.20544607979910715;" vertex="1" parent="1">
<mxGeometry x="40" y="550" width="240" height="50" as="geometry"/>
</mxCell>
<mxCell id="27" value="&lt;div&gt;&lt;span style=&quot;font-size: 14px;&quot;&gt;&lt;b&gt;polly_default_config_file [template]&lt;/b&gt;&lt;/span&gt;&lt;/div&gt;ppcpy/config/polly_global_config.json" style="shape=document;whiteSpace=wrap;html=1;boundedLbl=1;align=left;size=0.20544607979910715;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" vertex="1" parent="1">
<mxGeometry x="40" y="480" width="240" height="61" as="geometry"/>
</mxCell>
<mxCell id="28" value="" style="edgeStyle=elbowEdgeStyle;elbow=horizontal;endArrow=blockThin;html=1;curved=0;rounded=0;endSize=8;startSize=8;exitX=1;exitY=0.5;exitDx=0;exitDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="21">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="120" y="380" as="sourcePoint"/>
<mxPoint x="307" y="423" as="targetPoint"/>
<Array as="points"/>
</mxGeometry>
</mxCell>
<mxCell id="29" value="" style="edgeStyle=elbowEdgeStyle;elbow=vertical;endArrow=blockThin;html=1;curved=0;rounded=0;endSize=8;startSize=8;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0.132;entryY=1.018;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;entryPerimeter=0;" edge="1" parent="1" source="27" target="23">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="374.5" y="491" as="sourcePoint"/>
<mxPoint x="462.5" y="550" as="targetPoint"/>
<Array as="points">
<mxPoint x="310" y="511"/>
</Array>
</mxGeometry>
</mxCell>
<mxCell id="30" value="" style="edgeStyle=elbowEdgeStyle;elbow=vertical;endArrow=blockThin;html=1;curved=0;rounded=0;endSize=8;startSize=8;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0.25;entryY=1;entryDx=0;entryDy=0;strokeWidth=3;endFill=1;" edge="1" parent="1" source="26" target="23">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="360" y="568" as="sourcePoint"/>
<mxPoint x="425" y="533" as="targetPoint"/>
<Array as="points">
<mxPoint x="338" y="575"/>
</Array>
</mxGeometry>
</mxCell>
<mxCell id="31" value="polly_config_dict" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;fillColor=#cce5ff;strokeColor=#36393d;" vertex="1" parent="1">
<mxGeometry x="377" y="511" width="130" height="30" as="geometry"/>
</mxCell>
<mxCell id="32" value="" style="endArrow=blockThin;html=1;strokeWidth=3;endFill=1;exitX=0.75;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="23" target="31">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="406" y="238" as="sourcePoint"/>
<mxPoint x="407" y="420" as="targetPoint"/>
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Loading