Skip to content

Commit a5e2678

Browse files
authored
Updated documentation to include rejseplanen_source
1 parent 5f00a7e commit a5e2678

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/pybeamline.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,17 @@ In addition to the previous sources these are also implemented. The following so
204204
.subscribe(lambda x: print(str(x)))
205205
```
206206

207+
??? note "Details on `rejseplanen_source`"
208+
This source provides the data from the Danish railway system. Traces are represented as individual trains and events are trains reaching a certain station. The data is continuously generate (updated every 5 seconds, see <https://www.rejseplanen.dk/bin/help.exe/mn?L=vs_dot.vs_livemap&tpl=fullscreenmap>). The current source retrieves information about regional and light train (letbane).
209+
210+
Example usage:
211+
```python
212+
from pybeamline.sources.real_world_sources import rejseplanen_source
213+
214+
rejseplanen_source() \
215+
.subscribe(lambda x: print(str(x)))
216+
```
217+
207218

208219
### Combining sources
209220

0 commit comments

Comments
 (0)