Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrc-ide/odin.api
https://github.com/mrc-ide/odin.api
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mrc-ide/odin.api
- Owner: mrc-ide
- License: other
- Created: 2021-11-15T10:58:41.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-12T16:00:03.000Z (over 1 year ago)
- Last Synced: 2024-11-06T02:31:45.679Z (2 months ago)
- Language: R
- Size: 168 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# odin.api
[](https://www.repostatus.org/#concept)
[](https://github.com/mrc-ide/odin.api/actions)
[](https://buildkite.com/mrc-ide/odin-dot-api)
[](https://codecov.io/github/mrc-ide/odin.api?branch=main)
## Installation
To install `odin.api`:
```r
remotes::install_github("mrc-ide/odin.api", upgrade = FALSE)
```
## Usage
```
docker pull mrcide/odin.api:main
docker run -d --rm -p 8001:8001 mrcide/odin.api:main
```
Replace `:main` with any branch or SHA, or with a version number such as `v0.1.0` for versions that have been built from `main`. If you omit the branch or use `latest` it will pull/run the last version merged to `main`.
Informational root endpoint `GET /`
```
$ curl -s http://localhost:8001 | jq
{
"status": "success",
"errors": null,
"data": {
"odin": "1.3.1",
"odin.api": "0.1.0"
}
}
```
Check a model with `POST /validate`
```
$ curl -s -H 'Content-Type: application/json' \
--data '{"model": "deriv(x) <- a\ninitial(x) <- 1\na <- user(1)"}' \
http://localhost:8001/validate | jq
{
"status": "success",
"errors": null,
"data": {
"valid": true,
"metadata": {
"variables": [
"x"
],
"parameters": [
{
"default": 1,
"min": null,
"max": null,
"is_integer": false,
"rank": 0
}
],
"messages": []
}
}
}
```
Invalid models will return information about where they failed (note that this will return a HTTP 200 response)
```
$ curl -s -H 'Content-Type: application/json' \
--data '{"model": "deriv(x) <- z\ninitial(x) <- 1\na <- user(1)"}' \
http://localhost:8001/validate | jq
{
"status": "success",
"errors": null,
"data": {
"valid": false,
"error": {
"message": "Unknown variable z",
"line": [
1
]
}
}
}
```
Compile a model with `POST /compile`
```
$ curl -s -H 'Content-Type: application/json' \
--data '{"model": "deriv(x) <- a\ninitial(x) <- 1\na <- user(1)"}' \
http://localhost:8001/compile | jq
{
"status": "success",
"errors": null,
"data": {
"valid": true,
"metadata": {
"variables": [
"x"
],
"parameters": [
{
"name": "a",
"default": 1,
"min": null,
"max": null,
"is_integer": false,
"rank": 0
}
],
"messages": []
},
"model": "\"use strict\";\nclass odin {\n constructor(base, user, unusedUserAction) {\n this.base = base;\n this.internal = {};\n var internal = this.internal;\n internal.initial_x = 1;\n this.setUser(user, unusedUserAction);\n }\n rhs(t, state, dstatedt) {\n var internal = this.internal;\n dstatedt[0] = internal.a;\n }\n initial(t) {\n var internal = this.internal;\n var state = Array(1).fill(0);\n state[0] = internal.initial_x;\n return state;\n }\n updateMetadata() {\n this.metadata = {};\n var internal = this.internal;\n this.metadata.ynames = [\"t\", \"x\"];\n this.metadata.internalOrder = {a: null, initial_x: null};\n this.metadata.variableOrder = {x: null};\n this.metadata.outputOrder = null;\n }\n setUser(user, unusedUserAction) {\n this.base.user.checkUser(user, [\"a\"], unusedUserAction);\n var internal = this.internal;\n this.base.user.setUserScalar(user, \"a\", internal, 1, -Infinity, Infinity, false);\n this.updateMetadata();\n }\n names() {\n return this.metadata.ynames.slice(1);\n }\n getInternal() {\n return this.internal;\n }\n getMetadata() {\n return this.metadata;\n }\n}\nodin;"
}
}
```
The generated model is subject to, and expected to, change.
The two `POST` endpoints will accept either a string with embedded newlines or an array of strings as input.
Support code can be retrieved via the `/support/runner-ode` endpoint.
```
$ curl -s http://localhost:8001/support/runner-ode | jq
{
"status": "success",
"errors": null,
"data": "var odinjs;(()=>{\"use strict\";var t={886:(t,e)=>{function..."
```
## License
MIT © Imperial College of Science, Technology and Medicine