Skip to content

Commit c7c3f5c

Browse files
chraibischroedtert
chraibi
and
schroedtert
authored
Add loaders to user guide (#476)
* Add loaders to user guide Co-authored-by: schroedtert <t.schroedter@posteo.de>
1 parent 4856920 commit c7c3f5c

7 files changed

Lines changed: 16397 additions & 8 deletions

File tree

‎docs/source/developer_guide.rst‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -262,10 +262,12 @@ To simplify and automate formatting, linting, and type checking, we use pre-comm
262262

263263
To set up the pre-commit hooks locally, run the following command:
264264

265-
```bash
266-
pip install pre-commit
267-
pre-commit install
268-
```
265+
.. code-block:: bash
266+
267+
pip install pre-commit
268+
pre-commit install
269+
270+
269271
Now, every time you commit changes, the hooks will automatically run, checking for issues related to formatting, linting, and type hints.
270272

271273
.. note ::

‎notebooks/demo-data/crowdit/crowdit.csv.gz‎

5.26 KB
Binary file not shown.

‎notebooks/demo-data/crowdit/crowdit.floor‎

Lines changed: 357 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,357 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2+
<floor xmlFormat="0.11.7" isoDate="2025-09-02T09:59:41.157327Z">
3+
<layer id="jupedsim_obstacles">
4+
<wall closed="true" isCustom="false" deleted="false" id="w2">
5+
<point x="28.645999" y="36.314498"/>
6+
<point x="28.645999" y="36.384498"/>
7+
<point x="26.799999" y="36.384498"/>
8+
<point x="26.799999" y="37.049998"/>
9+
<point x="29.909999" y="37.049998"/>
10+
<point x="29.909999" y="37.219998"/>
11+
<point x="20.449999" y="37.219998"/>
12+
<point x="20.449999" y="37.049998"/>
13+
<point x="26.719999" y="37.049998"/>
14+
<point x="26.719999" y="36.311629"/>
15+
</wall>
16+
<wall closed="true" isCustom="false" deleted="false" id="w3">
17+
<point x="50.389997" y="20.340281"/>
18+
<point x="50.389997" y="18.789999"/>
19+
<point x="50.264997" y="18.789999"/>
20+
<point x="50.264997" y="20.340281"/>
21+
<point x="50.164997" y="20.340281"/>
22+
<point x="50.164997" y="20.490281"/>
23+
<point x="51.099997" y="20.490281"/>
24+
<point x="51.099997" y="25.492997"/>
25+
<point x="51.299997" y="25.492997"/>
26+
<point x="51.299997" y="24.894999"/>
27+
<point x="52.20999" y="24.894999"/>
28+
<point x="52.20999" y="24.734999"/>
29+
<point x="51.299997" y="24.734999"/>
30+
<point x="51.299997" y="21.884999"/>
31+
<point x="52.20999" y="21.884999"/>
32+
<point x="52.20999" y="21.724999"/>
33+
<point x="51.299997" y="21.724999"/>
34+
<point x="51.299997" y="20.490281"/>
35+
<point x="53.024997" y="20.490281"/>
36+
<point x="53.024997" y="20.340281"/>
37+
</wall>
38+
<wall closed="true" isCustom="false" deleted="false" id="w4">
39+
<point x="44.639997" y="15.945"/>
40+
<point x="44.814997" y="15.945"/>
41+
<point x="44.814997" y="16.57"/>
42+
<point x="48.869997" y="16.57"/>
43+
<point x="48.869997" y="16.155"/>
44+
<point x="48.994997" y="16.155"/>
45+
<point x="48.994997" y="16.695"/>
46+
<point x="48.319997" y="16.695"/>
47+
<point x="48.319997" y="17.779999"/>
48+
<point x="48.019997" y="17.779999"/>
49+
<point x="48.019997" y="16.820537"/>
50+
<point x="41.115002" y="16.820537"/>
51+
<point x="41.115002" y="19.575281"/>
52+
<point x="44.112497" y="19.575281"/>
53+
<point x="44.112497" y="19.690281"/>
54+
<point x="37.849998" y="19.690281"/>
55+
<point x="37.849998" y="20.490281"/>
56+
<point x="36.659998" y="20.490281"/>
57+
<point x="36.659998" y="20.540281"/>
58+
<point x="36.549998" y="20.540281"/>
59+
<point x="36.549998" y="19.390281"/>
60+
<point x="36.749998" y="19.390281"/>
61+
<point x="36.749998" y="20.375281"/>
62+
<point x="37.734998" y="20.375281"/>
63+
<point x="37.734998" y="19.575281"/>
64+
<point x="40.915002" y="19.575281"/>
65+
<point x="40.915002" y="16.72"/>
66+
<point x="36.749998" y="16.72"/>
67+
<point x="36.749998" y="18.160281"/>
68+
<point x="36.549998" y="18.160281"/>
69+
<point x="36.550841" y="16.57"/>
70+
<point x="44.639997" y="16.57"/>
71+
</wall>
72+
<wall closed="true" isCustom="false" deleted="false" id="w5">
73+
<point x="45.342497" y="19.690281"/>
74+
<point x="48.019997" y="19.690281"/>
75+
<point x="48.019997" y="20.490281"/>
76+
<point x="48.934997" y="20.490281"/>
77+
<point x="48.934997" y="20.340281"/>
78+
<point x="48.319997" y="20.340281"/>
79+
<point x="48.319997" y="18.789999"/>
80+
<point x="48.019997" y="18.789999"/>
81+
<point x="48.017517" y="19.575281"/>
82+
<point x="45.342497" y="19.575281"/>
83+
</wall>
84+
<wall closed="true" isCustom="false" deleted="false" id="w6">
85+
<point x="50.134997" y="14.02"/>
86+
<point x="50.134997" y="14.145"/>
87+
<point x="50.264997" y="14.145"/>
88+
<point x="50.264997" y="17.779999"/>
89+
<point x="50.389997" y="17.779999"/>
90+
<point x="50.389997" y="16.895"/>
91+
<point x="52.289974" y="16.895"/>
92+
<point x="52.289974" y="14.87"/>
93+
<point x="52.164974" y="14.87"/>
94+
<point x="52.164974" y="16.77"/>
95+
<point x="50.389997" y="16.77"/>
96+
<point x="50.389997" y="13.395282"/>
97+
<point x="55.099996" y="13.395282"/>
98+
<point x="55.099996" y="20.340281"/>
99+
<point x="54.254997" y="20.340281"/>
100+
<point x="54.254997" y="20.490281"/>
101+
<point x="55.099996" y="20.490281"/>
102+
<point x="55.099996" y="26.519999"/>
103+
<point x="52.569996" y="26.519999"/>
104+
<point x="52.569996" y="26.569999"/>
105+
<point x="55.269996" y="26.569999"/>
106+
<point x="55.269996" y="11.32"/>
107+
<point x="50.264997" y="11.32"/>
108+
<point x="50.264997" y="11.775"/>
109+
<point x="50.389997" y="11.775"/>
110+
<point x="50.389997" y="11.49"/>
111+
<point x="55.099996" y="11.49"/>
112+
<point x="55.099996" y="13.270282"/>
113+
<point x="50.389997" y="13.270282"/>
114+
<point x="50.389997" y="12.785"/>
115+
<point x="50.264997" y="12.785"/>
116+
<point x="50.264997" y="14.02"/>
117+
</wall>
118+
<wall closed="true" isCustom="true" deleted="false" id="w7">
119+
<point x="37.745122" y="37.049998"/>
120+
<point x="37.74599666513804" y="28.663944454503696"/>
121+
<point x="36.624998" y="28.602762"/>
122+
<point x="36.624998" y="28.379999"/>
123+
<point x="36.574998" y="28.379999"/>
124+
<point x="36.574998" y="37.049998"/>
125+
<point x="31.909999" y="37.049998"/>
126+
<point x="31.909999" y="37.219998"/>
127+
<point x="55.269996" y="37.219998"/>
128+
<point x="55.269996" y="28.669999"/>
129+
<point x="52.569996" y="28.669999"/>
130+
<point x="52.568358" y="28.723365"/>
131+
<point x="52.568358" y="30.143365"/>
132+
<point x="55.099996" y="30.143365"/>
133+
<point x="55.099996" y="31.234214"/>
134+
<point x="51.936683" y="31.234214"/>
135+
<point x="51.936683" y="32.174214"/>
136+
<point x="52.876683" y="32.174214"/>
137+
<point x="52.876683" y="33.624214"/>
138+
<point x="55.099996" y="33.624214"/>
139+
<point x="55.099996" y="37.049998"/>
140+
<point x="53.966399" y="37.049998"/>
141+
<point x="53.966399" y="35.484938"/>
142+
<point x="52.246399" y="35.484938"/>
143+
<point x="52.246399" y="33.604938"/>
144+
<point x="51.056399" y="33.604938"/>
145+
<point x="51.056399" y="37.049998"/>
146+
<point x="50.528827" y="37.049998"/>
147+
<point x="50.528827" y="28.37107"/>
148+
<point x="48.832078" y="28.37107"/>
149+
<point x="48.832078" y="37.049998"/>
150+
<point x="47.763759" y="37.049998"/>
151+
<point x="47.763759" y="34.524462"/>
152+
<point x="45.950155" y="34.524462"/>
153+
<point x="45.950155" y="37.049998"/>
154+
<point x="45.381536" y="37.049998"/>
155+
<point x="45.381536" y="34.524462"/>
156+
<point x="43.567933" y="34.524462"/>
157+
<point x="43.567933" y="37.049998"/>
158+
<point x="42.972688" y="37.049998"/>
159+
<point x="42.972688" y="34.524462"/>
160+
<point x="41.159084" y="34.524462"/>
161+
<point x="41.159084" y="37.049998"/>
162+
<point x="40.177906" y="37.049998"/>
163+
<point x="40.177906" y="28.358648"/>
164+
<point x="38.466149" y="28.358648"/>
165+
<point x="38.466149" y="37.049998"/>
166+
</wall>
167+
<wall closed="true" isCustom="false" deleted="false" id="w8">
168+
<point x="41.234997" y="25.699023"/>
169+
<point x="41.234997" y="25.398997"/>
170+
<point x="47.844997" y="25.398997"/>
171+
<point x="47.844997" y="25.699023"/>
172+
</wall>
173+
<wall closed="true" isCustom="false" deleted="false" id="w9">
174+
<point x="11.36" y="11.32"/>
175+
<point x="29.785" y="11.32"/>
176+
<point x="29.785" y="13.97"/>
177+
<point x="29.734998" y="13.97"/>
178+
<point x="29.735" y="11.49"/>
179+
<point x="11.53" y="11.49"/>
180+
<point x="11.524993" y="18.169999"/>
181+
<point x="21.024999" y="18.169999"/>
182+
<point x="21.024999" y="18.420001"/>
183+
<point x="11.359999" y="18.42"/>
184+
</wall>
185+
<wall closed="true" isCustom="false" deleted="false" id="w10">
186+
<point x="31.934998" y="13.97"/>
187+
<point x="31.884998" y="13.97"/>
188+
<point x="31.884998" y="11.32"/>
189+
<point x="43.254997" y="11.32"/>
190+
<point x="43.254997" y="13.484982"/>
191+
<point x="43.014997" y="13.484982"/>
192+
<point x="43.014997" y="11.49"/>
193+
<point x="36.737498" y="11.49"/>
194+
<point x="36.737498" y="15.0325"/>
195+
<point x="43.014997" y="15.0325"/>
196+
<point x="43.014997" y="14.494982"/>
197+
<point x="43.254997" y="14.494982"/>
198+
<point x="43.254997" y="14.711253"/>
199+
<point x="43.442502" y="14.711253"/>
200+
<point x="43.442502" y="14.836253"/>
201+
<point x="43.254997" y="14.836253"/>
202+
<point x="43.254997" y="15.17"/>
203+
<point x="36.659998" y="15.17"/>
204+
<point x="36.659998" y="15.22"/>
205+
<point x="36.549998" y="15.22"/>
206+
<point x="36.549998" y="11.49"/>
207+
<point x="31.935" y="11.49"/>
208+
</wall>
209+
<wall closed="true" isCustom="false" deleted="false" id="w11">
210+
<point x="28.645999" y="34.789498"/>
211+
<point x="26.799999" y="34.789498"/>
212+
<point x="26.799986" y="18.169999"/>
213+
<point x="23.924999" y="18.169999"/>
214+
<point x="23.924994" y="21.870001"/>
215+
<point x="11.53" y="21.870001"/>
216+
<point x="11.53" y="20.22"/>
217+
<point x="11.36" y="20.22"/>
218+
<point x="11.36" y="37.219998"/>
219+
<point x="18.449999" y="37.219998"/>
220+
<point x="18.449999" y="37.049998"/>
221+
<point x="11.53" y="37.049998"/>
222+
<point x="11.53" y="22.1199"/>
223+
<point x="26.719999" y="22.1199"/>
224+
<point x="26.719999" y="34.859499"/>
225+
<point x="28.645999" y="34.859498"/>
226+
</wall>
227+
<wall closed="true" isCustom="false" deleted="false" id="w12">
228+
<point x="13.725057" y="34.9179"/>
229+
<point x="13.725057" y="34.6929"/>
230+
<point x="24.259057" y="34.6929"/>
231+
<point x="24.259057" y="34.9179"/>
232+
</wall>
233+
<wall closed="true" isCustom="false" deleted="false" id="w13">
234+
<point x="13.725057" y="34.0679"/>
235+
<point x="13.725057" y="33.8429"/>
236+
<point x="24.259057" y="33.8429"/>
237+
<point x="24.259057" y="34.0679"/>
238+
</wall>
239+
<wall closed="true" isCustom="false" deleted="false" id="w14">
240+
<point x="13.725057" y="33.21128"/>
241+
<point x="13.725057" y="32.98628"/>
242+
<point x="24.259057" y="32.98628"/>
243+
<point x="24.259057" y="33.21128"/>
244+
</wall>
245+
<wall closed="true" isCustom="false" deleted="false" id="w15">
246+
<point x="13.725057" y="31.560281"/>
247+
<point x="13.725057" y="31.335281"/>
248+
<point x="24.259057" y="31.335281"/>
249+
<point x="24.259057" y="31.560281"/>
250+
</wall>
251+
<wall closed="true" isCustom="false" deleted="false" id="w16">
252+
<point x="13.725057" y="29.853661"/>
253+
<point x="13.725057" y="29.628661"/>
254+
<point x="24.259057" y="29.628661"/>
255+
<point x="24.259057" y="29.853661"/>
256+
</wall>
257+
<wall closed="true" isCustom="false" deleted="false" id="w17">
258+
<point x="13.725057" y="28.1179"/>
259+
<point x="13.725057" y="27.8929"/>
260+
<point x="24.259057" y="27.8929"/>
261+
<point x="24.259057" y="28.1179"/>
262+
</wall>
263+
<wall closed="true" isCustom="false" deleted="false" id="w18">
264+
<point x="13.725057" y="26.41128"/>
265+
<point x="13.725057" y="26.18628"/>
266+
<point x="24.259057" y="26.18628"/>
267+
<point x="24.259057" y="26.41128"/>
268+
</wall>
269+
<wall closed="true" isCustom="false" deleted="false" id="w19">
270+
<point x="13.725057" y="24.784169"/>
271+
<point x="13.725057" y="24.559169"/>
272+
<point x="24.259057" y="24.559169"/>
273+
<point x="24.259057" y="24.784169"/>
274+
</wall>
275+
<wall closed="true" isCustom="false" deleted="false" id="w20">
276+
<point x="13.725057" y="32.365247"/>
277+
<point x="13.725057" y="32.140247"/>
278+
<point x="24.259057" y="32.140247"/>
279+
<point x="24.259057" y="32.365247"/>
280+
</wall>
281+
<wall closed="true" isCustom="false" deleted="false" id="w21">
282+
<point x="13.725057" y="30.707628"/>
283+
<point x="13.725057" y="30.482628"/>
284+
<point x="24.259057" y="30.482628"/>
285+
<point x="24.259057" y="30.707628"/>
286+
</wall>
287+
<wall closed="true" isCustom="false" deleted="false" id="w22">
288+
<point x="13.725057" y="29.001008"/>
289+
<point x="13.725057" y="28.776008"/>
290+
<point x="24.259057" y="28.776008"/>
291+
<point x="24.259057" y="29.001008"/>
292+
</wall>
293+
<wall closed="true" isCustom="false" deleted="false" id="w23">
294+
<point x="13.725057" y="27.265247"/>
295+
<point x="13.725057" y="27.040247"/>
296+
<point x="24.259057" y="27.040247"/>
297+
<point x="24.259057" y="27.265247"/>
298+
</wall>
299+
<wall closed="true" isCustom="false" deleted="false" id="w24">
300+
<point x="13.725057" y="25.558627"/>
301+
<point x="13.725057" y="25.333627"/>
302+
<point x="24.259057" y="25.333627"/>
303+
<point x="24.259057" y="25.558627"/>
304+
</wall>
305+
<wall closed="true" isCustom="false" deleted="false" id="w25">
306+
<point x="42.973831" y="33.442284"/>
307+
<point x="42.973831" y="28.052284"/>
308+
<point x="41.159084" y="28.052284"/>
309+
<point x="41.159084" y="33.442284"/>
310+
</wall>
311+
<wall closed="true" isCustom="false" deleted="false" id="w26">
312+
<point x="45.38268" y="33.442284"/>
313+
<point x="45.38268" y="28.052284"/>
314+
<point x="43.567933" y="28.052284"/>
315+
<point x="43.567933" y="33.442284"/>
316+
</wall>
317+
<wall closed="true" isCustom="false" deleted="false" id="w27">
318+
<point x="47.764902" y="33.442284"/>
319+
<point x="47.764902" y="28.052284"/>
320+
<point x="45.950155" y="28.052284"/>
321+
<point x="45.950155" y="33.442284"/>
322+
</wall>
323+
<wall closed="true" isCustom="false" deleted="false" id="w28">
324+
<point x="36.749998" y="25.494999"/>
325+
<point x="36.749998" y="21.490281"/>
326+
<point x="36.549998" y="21.490281"/>
327+
<point x="36.574998" y="25.494999"/>
328+
</wall>
329+
<wall closed="true" isCustom="false" deleted="false" id="w29">
330+
<point x="44.375" y="11.49"/>
331+
<point x="44.639997" y="11.49"/>
332+
<point x="44.639997" y="14.711253"/>
333+
<point x="44.452502" y="14.711253"/>
334+
<point x="44.452502" y="14.836253"/>
335+
<point x="44.639997" y="14.836253"/>
336+
<point x="44.639997" y="14.935"/>
337+
<point x="44.814999" y="14.935"/>
338+
<point x="44.814997" y="11.49"/>
339+
<point x="48.019997" y="11.49"/>
340+
<point x="48.019997" y="15.095"/>
341+
<point x="48.882497" y="15.095"/>
342+
<point x="48.882497" y="15.145"/>
343+
<point x="48.994997" y="15.145"/>
344+
<point x="48.994997" y="14.145"/>
345+
<point x="49.124997" y="14.145"/>
346+
<point x="49.124997" y="14.019998"/>
347+
<point x="48.994997" y="14.02"/>
348+
<point x="48.994997" y="13.27"/>
349+
<point x="48.319997" y="13.27"/>
350+
<point x="48.319997" y="11.49"/>
351+
<point x="49.154997" y="11.49"/>
352+
<point x="49.154997" y="11.32"/>
353+
<point x="44.375" y="11.32"/>
354+
</wall>
355+
</layer>
356+
<layer id="0"/>
357+
</floor>

‎notebooks/demo-data/jupedsim/trajectories.sqlite‎

520 KB
Binary file not shown.

0 commit comments

Comments
 (0)