https://github.com/mrc-ide/odin.dust

Compile odin to dust
https://github.com/mrc-ide/odin.dust

Last synced: about 2 months ago
JSON representation

Compile odin to dust

• Host: GitHub
• URL: https://github.com/mrc-ide/odin.dust
• Owner: mrc-ide
• License: other
• Created: 2020-06-19T07:48:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-25T13:37:47.000Z (6 months ago)
• Last Synced: 2024-06-25T15:03:45.146Z (6 months ago)
• Language: R
• Homepage: https://mrc-ide.github.io/odin.dust
• Size: 3.99 MB
• Stars: 3
• Watchers: 5
• Forks: 1
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# odin.dust 

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)

[![R build status](https://github.com/mrc-ide/odin.dust/workflows/R-CMD-check/badge.svg)](https://github.com/mrc-ide/odin.dust/actions)

[![CodeFactor](https://www.codefactor.io/repository/github/mrc-ide/odin.dust/badge)](https://www.codefactor.io/repository/github/mrc-ide/odin.dust)

[![codecov.io](https://codecov.io/github/mrc-ide/odin.dust/coverage.svg?branch=master)](https://codecov.io/github/mrc-ide/odin.dust?branch=master)

Compile an [odin](https://mrc-ide.github.io/odin/) model to work with [dust](https://mrc-ide.github.io/dust/), so that a stochastic model can be run in parallel, for example in a particle filter such as [mcstate](https://mrc-ide.github.io/mcstate/).

This works only for models that are discrete time, and makes sense only for models that are stochastic. Within these models you cannot use `output()`, interpolation functions or delays. Not all distributions are supported by dust.

See `vignette("porting")` for details.

## Installation

Please install from our [r-universe](https://mrc-ide.r-universe.dev/):

```

install.packages(

  "odin.dust",

  repos = c("https://mrc-ide.r-universe.dev", "https://cloud.r-project.org"))

```

If you prefer, you can install from GitHub with remotes:

```

remotes::install_github("mrc-ide/odin.dust")

```

You will need recent versions of the `dust` and `odin` to use this package, which can be installed in the same way.

## License

MIT © Imperial College of Science, Technology and Medicine