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.

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 and fix documentation for cluster point process generation #705

Open
stiber opened this issue Sep 25, 2024 · 1 comment
Open

Update and fix documentation for cluster point process generation #705

stiber opened this issue Sep 25, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@stiber
Copy link
Contributor

stiber commented Sep 25, 2024

The developer's documentation contains more information about the [simulation input file
format and the class that loads and manages the event inputs]
(https://uwb-biocomputing.github.io/Graphitti/Developer/GraphAndEventInputs.html).
Below is an example of a simulation input file:
```XML
?xml version='1.0' encoding='UTF-8'?>
<simulator_inputs>
<data description="SPD Calls - Cluster Point Process" clock_tick_size="1" clock_tick_unit="sec">
<vertex id="194" name="SEATTLE PD Caller region">
<event time="12" duration="568" x="-122.43656117361931" y="47.604800151342786" type="Law" vertex_id="194"/>
<event time="99" duration="36" x="-122.43611438152655" y="47.5321990385178" type="EMS" vertex_id="194"/>
<event time="336" duration="100" x="-122.34868883298704" y="47.56973909330686" type="Law" vertex_id="194"/>
<event time="601" duration="367" x="-122.44122311134316" y="47.70298531339788" type="Law" vertex_id="194"/>
<event time="766" duration="96" x="-122.28084792007573" y="47.70594997190379" type="Fire" vertex_id="194"/>
...
</vertex>
</data>
</simulator_inputs>

In the above documentation, the hyperlink isn't formatted right and the data file example must be from an early version of the code.

@stiber stiber added the documentation Improvements or additions to documentation label Sep 25, 2024
@stiber
Copy link
Contributor Author

stiber commented Sep 25, 2024

Also, the linked GitHub pages file has an old example data file in it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants