Skip to content

Commit a963c2a

Browse files
JosePizarro3JosePizarro3
authored
Create process for masterdata (#15)
* Added structure and style for mkdocs page Added tutorial md file for create masterdata * Added masterdata-workflow.drawio * Moved drawio to subfolder * Added masterdata-workflow.drawio.png * Minor touches on the style * Changed github icon
1 parent 8781647 commit a963c2a

24 files changed

+426
-23
lines changed

‎docs/assets/datastore-logo-white.png‎

24.4 KB
Loading

‎docs/assets/drawio/masterdata-workflow.drawio‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:132.0) Gecko/20100101 Firefox/132.0" version="25.0.3">
2+
<diagram name="Page-1" id="0Vyze75IJXNyw1NAYiIs">
3+
<mxGraphModel dx="2218" dy="1980" 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">
4+
<root>
5+
<mxCell id="0" />
6+
<mxCell id="1" parent="0" />
7+
<mxCell id="piQVccZ1z7M02Xxa8-p4-25" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;startArrow=classic;startFill=1;endArrow=none;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-40" target="piQVccZ1z7M02Xxa8-p4-9">
8+
<mxGeometry relative="1" as="geometry" />
9+
</mxCell>
10+
<mxCell id="piQVccZ1z7M02Xxa8-p4-27" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;startArrow=classic;startFill=1;endArrow=none;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-36" target="piQVccZ1z7M02Xxa8-p4-12">
11+
<mxGeometry relative="1" as="geometry" />
12+
</mxCell>
13+
<mxCell id="piQVccZ1z7M02Xxa8-p4-28" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;startArrow=classic;startFill=1;endArrow=none;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-38" target="piQVccZ1z7M02Xxa8-p4-11">
14+
<mxGeometry relative="1" as="geometry" />
15+
</mxCell>
16+
<mxCell id="piQVccZ1z7M02Xxa8-p4-7" value="" style="group" vertex="1" connectable="0" parent="1">
17+
<mxGeometry x="680" y="-145" width="500" height="290" as="geometry" />
18+
</mxCell>
19+
<mxCell id="piQVccZ1z7M02Xxa8-p4-6" value="&lt;ul style=&quot;padding-left: 20px;&quot;&gt;&lt;li&gt;In Github&lt;/li&gt;&lt;li&gt;We provide:&lt;/li&gt;&lt;ul&gt;&lt;li&gt;instructions in README&lt;/li&gt;&lt;li&gt;add same instructions to bam-data-store documentation&lt;/li&gt;&lt;li&gt;pyproject.toml&lt;/li&gt;&lt;li&gt;src/ and tests/ folder structure&lt;/li&gt;&lt;li&gt;a Python module per entity type&lt;/li&gt;&lt;li&gt;a pytest testing module per entity type&lt;/li&gt;&lt;li&gt;a masterdata.xlsx template&lt;br&gt;&lt;/li&gt;&lt;/ul&gt;&lt;li&gt;Licensing?&lt;/li&gt;&lt;/ul&gt;" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=3;strokeColor=#002832;align=left;verticalAlign=top;fontSize=14;" vertex="1" parent="piQVccZ1z7M02Xxa8-p4-7">
20+
<mxGeometry x="260" width="240" height="290" as="geometry" />
21+
</mxCell>
22+
<mxCell id="piQVccZ1z7M02Xxa8-p4-4" value="masterdata-template" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#325463;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=24;strokeColor=#002832;strokeWidth=3;" vertex="1" parent="piQVccZ1z7M02Xxa8-p4-7">
23+
<mxGeometry y="115" width="260" height="60" as="geometry" />
24+
</mxCell>
25+
<mxCell id="piQVccZ1z7M02Xxa8-p4-13" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=2;dashed=1;endArrow=open;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-9" target="piQVccZ1z7M02Xxa8-p4-4">
26+
<mxGeometry relative="1" as="geometry" />
27+
</mxCell>
28+
<mxCell id="piQVccZ1z7M02Xxa8-p4-17" value="&lt;font style=&quot;font-size: 14px;&quot; face=&quot;Klavika&quot;&gt;&lt;i&gt;Use this template&lt;br&gt;&lt;/i&gt;&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="piQVccZ1z7M02Xxa8-p4-13">
29+
<mxGeometry x="-0.1178" y="3" relative="1" as="geometry">
30+
<mxPoint as="offset" />
31+
</mxGeometry>
32+
</mxCell>
33+
<mxCell id="piQVccZ1z7M02Xxa8-p4-9" value="bam-masterdata-&amp;lt;usecase1&amp;gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#FF0025;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=20;strokeColor=#002832;strokeWidth=2;dashed=1;" vertex="1" parent="1">
34+
<mxGeometry x="210" y="-30" width="190" height="60" as="geometry" />
35+
</mxCell>
36+
<mxCell id="piQVccZ1z7M02Xxa8-p4-20" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;endArrow=open;endFill=0;strokeWidth=2;dashed=1;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-12" target="piQVccZ1z7M02Xxa8-p4-4">
37+
<mxGeometry relative="1" as="geometry" />
38+
</mxCell>
39+
<mxCell id="piQVccZ1z7M02Xxa8-p4-22" value="&lt;font style=&quot;font-size: 14px;&quot; face=&quot;Klavika&quot;&gt;&lt;i&gt;Use this template&lt;br&gt;&lt;/i&gt;&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="piQVccZ1z7M02Xxa8-p4-20">
40+
<mxGeometry x="-0.0509" y="-4" relative="1" as="geometry">
41+
<mxPoint x="1" as="offset" />
42+
</mxGeometry>
43+
</mxCell>
44+
<mxCell id="piQVccZ1z7M02Xxa8-p4-12" value="bam-masterdata-&amp;lt;usecaseX&amp;gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#FF0025;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=20;strokeColor=#002832;strokeWidth=2;dashed=1;" vertex="1" parent="1">
45+
<mxGeometry x="780" y="250" width="190" height="60" as="geometry" />
46+
</mxCell>
47+
<mxCell id="piQVccZ1z7M02Xxa8-p4-11" value="bam-masterdata-&amp;lt;usecase2&amp;gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#FF0025;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=20;strokeColor=#002832;strokeWidth=2;dashed=1;" vertex="1" parent="1">
48+
<mxGeometry x="440" y="65" width="190" height="60" as="geometry" />
49+
</mxCell>
50+
<mxCell id="piQVccZ1z7M02Xxa8-p4-19" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=2;dashed=1;endArrow=open;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-11" target="piQVccZ1z7M02Xxa8-p4-4">
51+
<mxGeometry relative="1" as="geometry" />
52+
</mxCell>
53+
<mxCell id="piQVccZ1z7M02Xxa8-p4-21" value="&lt;font style=&quot;font-size: 14px;&quot; face=&quot;Klavika&quot;&gt;&lt;i&gt;Use this template&lt;br&gt;&lt;/i&gt;&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="piQVccZ1z7M02Xxa8-p4-19">
54+
<mxGeometry x="-0.3613" y="-4" relative="1" as="geometry">
55+
<mxPoint as="offset" />
56+
</mxGeometry>
57+
</mxCell>
58+
<mxCell id="piQVccZ1z7M02Xxa8-p4-30" value="" style="group" vertex="1" connectable="0" parent="1">
59+
<mxGeometry x="-60" y="182.5" width="570" height="355" as="geometry" />
60+
</mxCell>
61+
<mxCell id="piQVccZ1z7M02Xxa8-p4-1" value="&lt;font&gt;bam&lt;/font&gt;-data-store" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#325463;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=30;strokeColor=#002832;strokeWidth=3;" vertex="1" parent="piQVccZ1z7M02Xxa8-p4-30">
62+
<mxGeometry x="320" y="147.5" width="250" height="60" as="geometry" />
63+
</mxCell>
64+
<mxCell id="piQVccZ1z7M02Xxa8-p4-29" value="&lt;ul style=&quot;padding-left: 20px;&quot;&gt;&lt;li&gt;In Github&lt;/li&gt;&lt;li&gt;Python:&lt;/li&gt;&lt;ul&gt;&lt;li&gt;bam_data_store/definitions/ defines the basic classes to be used by the entities datamodel&lt;/li&gt;&lt;li&gt;bam_data_store/datamodel/ contains the native BAM Data Store model (the common and abstract classes)&lt;/li&gt;&lt;/ul&gt;&lt;li&gt;Licensing?&lt;/li&gt;&lt;li&gt;Contains:&lt;/li&gt;&lt;ul&gt;&lt;li&gt;specific use-cases packages&lt;/li&gt;&lt;li&gt;JSONs for the full masterdata&lt;br&gt;&lt;/li&gt;&lt;/ul&gt;&lt;li&gt;Integrated with openBIS instances (with a method to `push_to_openbis()`)&lt;br&gt;&lt;/li&gt;&lt;li&gt;Frontend:&lt;/li&gt;&lt;ul&gt;&lt;li&gt;buttons to documentation, main instance, masterdata-checker&lt;br&gt;&lt;/li&gt;&lt;li&gt;visualization of masterdata entities (D3.js)&lt;br&gt;&lt;/li&gt;&lt;/ul&gt;&lt;/ul&gt;" style="rounded=0;whiteSpace=wrap;html=1;strokeWidth=3;strokeColor=#002832;align=left;verticalAlign=top;fontSize=14;" vertex="1" parent="piQVccZ1z7M02Xxa8-p4-30">
65+
<mxGeometry width="320" height="355" as="geometry" />
66+
</mxCell>
67+
<mxCell id="piQVccZ1z7M02Xxa8-p4-31" value="&lt;div&gt;openBIS&lt;/div&gt;&lt;div&gt;instance&lt;br&gt;&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#CCD8DF;fontFamily=Klavika;fontColor=#002832;textShadow=0;fontSize=40;strokeColor=#002832;strokeWidth=3;fontStyle=1" vertex="1" parent="1">
68+
<mxGeometry x="370" y="660" width="260" height="130" as="geometry" />
69+
</mxCell>
70+
<mxCell id="piQVccZ1z7M02Xxa8-p4-32" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-5" target="piQVccZ1z7M02Xxa8-p4-31">
71+
<mxGeometry relative="1" as="geometry" />
72+
</mxCell>
73+
<mxCell id="piQVccZ1z7M02Xxa8-p4-34" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-1" target="piQVccZ1z7M02Xxa8-p4-5">
74+
<mxGeometry relative="1" as="geometry">
75+
<mxPoint x="385" y="390" as="sourcePoint" />
76+
<mxPoint x="500" y="660" as="targetPoint" />
77+
</mxGeometry>
78+
</mxCell>
79+
<mxCell id="piQVccZ1z7M02Xxa8-p4-35" value="&lt;font face=&quot;Klavika&quot; style=&quot;font-size: 16px;&quot;&gt;push_to_openbis()&lt;/font&gt;" style="edgeLabel;html=1;align=center;verticalAlign=middle;resizable=0;points=[];" vertex="1" connectable="0" parent="piQVccZ1z7M02Xxa8-p4-34">
80+
<mxGeometry x="-0.0963" y="1" relative="1" as="geometry">
81+
<mxPoint x="-39" y="-29" as="offset" />
82+
</mxGeometry>
83+
</mxCell>
84+
<mxCell id="piQVccZ1z7M02Xxa8-p4-5" value="masterdata-checker" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#325463;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=18;strokeColor=#002832;strokeWidth=3;" vertex="1" parent="1">
85+
<mxGeometry x="405" y="510" width="190" height="60" as="geometry" />
86+
</mxCell>
87+
<mxCell id="piQVccZ1z7M02Xxa8-p4-37" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;startArrow=classic;startFill=1;endArrow=none;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-1" target="piQVccZ1z7M02Xxa8-p4-36">
88+
<mxGeometry relative="1" as="geometry">
89+
<mxPoint x="510" y="360" as="sourcePoint" />
90+
<mxPoint x="785" y="280" as="targetPoint" />
91+
</mxGeometry>
92+
</mxCell>
93+
<mxCell id="piQVccZ1z7M02Xxa8-p4-36" value="masterdata-checker" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#325463;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=18;strokeColor=#002832;strokeWidth=3;" vertex="1" parent="1">
94+
<mxGeometry x="783.75" y="360" width="182.5" height="60" as="geometry" />
95+
</mxCell>
96+
<mxCell id="piQVccZ1z7M02Xxa8-p4-39" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;startArrow=classic;startFill=1;endArrow=none;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-1" target="piQVccZ1z7M02Xxa8-p4-38">
97+
<mxGeometry relative="1" as="geometry">
98+
<mxPoint x="385" y="330" as="sourcePoint" />
99+
<mxPoint x="520" y="150" as="targetPoint" />
100+
</mxGeometry>
101+
</mxCell>
102+
<mxCell id="piQVccZ1z7M02Xxa8-p4-38" value="masterdata-checker" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#325463;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=18;strokeColor=#002832;strokeWidth=3;" vertex="1" parent="1">
103+
<mxGeometry x="440" y="210" width="190" height="60" as="geometry" />
104+
</mxCell>
105+
<mxCell id="piQVccZ1z7M02Xxa8-p4-41" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;strokeWidth=3;startArrow=classic;startFill=1;endArrow=none;endFill=0;" edge="1" parent="1" source="piQVccZ1z7M02Xxa8-p4-1" target="piQVccZ1z7M02Xxa8-p4-40">
106+
<mxGeometry relative="1" as="geometry">
107+
<mxPoint x="385" y="330" as="sourcePoint" />
108+
<mxPoint x="305" y="30" as="targetPoint" />
109+
</mxGeometry>
110+
</mxCell>
111+
<mxCell id="piQVccZ1z7M02Xxa8-p4-40" value="masterdata-checker" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#325463;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=18;strokeColor=#002832;strokeWidth=3;" vertex="1" parent="1">
112+
<mxGeometry x="210" y="65" width="190" height="60" as="geometry" />
113+
</mxCell>
114+
<mxCell id="piQVccZ1z7M02Xxa8-p4-44" value="name" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#325463;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=20;strokeColor=#002832;strokeWidth=3;" vertex="1" parent="1">
115+
<mxGeometry x="-280" y="-70" width="100" height="50" as="geometry" />
116+
</mxCell>
117+
<mxCell id="piQVccZ1z7M02Xxa8-p4-45" value="DataStore Github repository" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Klavika;fontSize=16;" vertex="1" parent="1">
118+
<mxGeometry x="-170" y="-60" width="140" height="30" as="geometry" />
119+
</mxCell>
120+
<mxCell id="piQVccZ1z7M02Xxa8-p4-47" value="Division-specific Github repository" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Klavika;fontSize=16;" vertex="1" parent="1">
121+
<mxGeometry x="-170" y="10" width="140" height="30" as="geometry" />
122+
</mxCell>
123+
<mxCell id="piQVccZ1z7M02Xxa8-p4-48" value="name" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#FF0025;fontFamily=Klavika;fontColor=#FFFFFF;textShadow=0;fontSize=20;strokeColor=#002832;strokeWidth=2;dashed=1;" vertex="1" parent="1">
124+
<mxGeometry x="-280" width="100" height="50" as="geometry" />
125+
</mxCell>
126+
<mxCell id="piQVccZ1z7M02Xxa8-p4-50" value="name" style="rounded=1;whiteSpace=wrap;html=1;fillColor=#CCD8DF;fontFamily=Klavika;fontColor=#002832;textShadow=0;fontSize=20;strokeColor=#002832;strokeWidth=3;fontStyle=1" vertex="1" parent="1">
127+
<mxGeometry x="-280" y="72.5" width="100" height="47.5" as="geometry" />
128+
</mxCell>
129+
<mxCell id="piQVccZ1z7M02Xxa8-p4-51" value="openBIS instance" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontFamily=Klavika;fontSize=16;" vertex="1" parent="1">
130+
<mxGeometry x="-170" y="81.25" width="140" height="30" as="geometry" />
131+
</mxCell>
132+
</root>
133+
</mxGraphModel>
134+
</diagram>
135+
</mxfile>

‎docs/assets/drawio/masterdata-workflow.drawio.png‎

221 KB
Loading

‎docs/explanations/data-store.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
!!! warning
3+
This page is still under construction.

‎docs/explanations/openbis.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
!!! warning
3+
This page is still under construction.

‎docs/explanations/pybis.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
!!! warning
3+
This page is still under construction.

‎docs/howtos/overview.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
!!! warning
3+
This page is still under construction.

‎docs/howtos/pybis/collections.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
!!! warning
3+
This page is still under construction.

‎docs/howtos/pybis/datasets.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
!!! warning
3+
This page is still under construction.

‎docs/howtos/pybis/objects.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
!!! warning
3+
This page is still under construction.

0 commit comments

Comments
 (0)