-
Notifications
You must be signed in to change notification settings - Fork 22
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
feat: add runtime and runtime-async packages #200
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…runtime-async packages
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #198
This adds the
@sdeverywhere/runtime
and@sdeverywhere/runtime-async
packages. These were originally developed in an internal repo under the namessde-model
andsde-model-async
. The only changes between the original sources and the ones here are:ModelRunner
andModelScheduler
terminate
function on theModelRunner
interfacegen-docs.js
script that uses typedoc and typedoc-plugin-markdown to generate Markdown API docs (that are currently maintained in the repo under thedocs
directories for ease of access and updating)These packages have been in use in En-ROADS and C-ROADS for over a year and a half and haven't had many changes in that time, so I consider them to be pretty stable. There may be a few API tweaks required once we start testing other models with them (for example, we'll need to fix the
Outputs
type to support models that use a "saveper" value other than 1), but I think this is good enough for a0.1.0
release.(Regarding the API docs, the internal repo used a different typedoc plugin that generated fancier HTML docs, but I like the simplicity of generating Markdown, and while I normally don't like keeping generated files in a repo, in this case it works pretty well since the Markdown pages are linked and browsable on GitHub, and it's easier than deploying docs to a separate server or GH Pages. We also have the added benefit of being able to see easily when there are API changes by looking at the diffs of the generated docs.)
/cc @ToddFincannon