JuliaDynamics / JuliaDynamics/ConcurrentSim.jl

better documentation for behavior of "edge" events scheduled for exactly the end time of a simulation run

Open
#138 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
198
Forks
40
Avg merge
21h 40m
Merged PRs (30d)
2

Description

When I run the docs example https://juliadynamics.github.io/ConcurrentSim.jl/stable/#Example I get exactly the output shown.

But then if I run run again I get further output:

julia> run(sim, 2)
slow 2.0
fast 2.0

Is this the intended functionality ?
I would say that "slow 2.0" and "fast 2.0" should either be printed the first time I call run(sim, 2) or not be printed at all. In the docs you say

The simulation will then stop when the internal clock reaches 10 but will not process any events scheduled for time 10. This is similar to a new environment where the clock is 0 but (obviously) no events have yet been processed.

So I guess, "slow 2.0" and "fast 2.0" shouldn't be printed even when I call run(sim, 2) again ?

Overall, it's pretty confusing that the edge events are called only the second time I call run and I have the impression it shouldn't be this way ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked docs example and the Simulation control guide. Compare the documented end-time behavior with the observed output from calling run(sim, 2) twice, then clarify the intended handling of events scheduled exactly at the simulation end time. Done means the example and guide consistently explain whether those edge events are processed.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.