diff options
| author | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2020-10-01 00:32:46 +0200 |
|---|---|---|
| committer | Fabian Mastenbroek <mail.fabianm@gmail.com> | 2020-10-01 00:32:46 +0200 |
| commit | 27ddd462d148d70760e45f967387905054e21d20 (patch) | |
| tree | f85bc767a047b382017828a6229d722abe7d6b36 /simulator/odcsim/README.md | |
| parent | 0df646c2951e9950f27472fdf0cb2624303c2d74 (diff) | |
Remove odcsim components from repository
This change removes the odcsim components from the repository as we have
eliminated their use in the OpenDC codebase, by replacing them with the
more generic (Test)CoroutineScope and Clock. From now on, we will only
place modules under the OpenDC namespace and not use odcsim as well to
prevent confusion.
Diffstat (limited to 'simulator/odcsim/README.md')
| -rw-r--r-- | simulator/odcsim/README.md | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/simulator/odcsim/README.md b/simulator/odcsim/README.md deleted file mode 100644 index 78cfaa27..00000000 --- a/simulator/odcsim/README.md +++ /dev/null @@ -1,54 +0,0 @@ -<h1 align="center"> - <a href="http://opendc.org/"> - <img src="../misc/artwork/logo.png" width="100" alt="OpenDC"> - </a> - <br> - odcsim -</h1> - -## Introduction -**odcsim** is a framework for discrete event simulation in Kotlin, used -by the [OpenDC](https://opendc.org) project. -Projects are defined in terms of a hierarchical grouping of actors -and the interactions between these actors -([Actor model](https://en.wikipedia.org/wiki/Actor_model)). - -## Getting Started - -The instructions below are meant for when you would like to use `odcsim` separately from `opendc`. If you simply want to use the simulator, you do not need to follow them, please refer to the [main README](../README.md) for instructions. - -### Installation -Please add the required packages as dependency in your project. -Releases are available in the [Maven Central Repository](https://search.maven.org/). - -The package `odcsim-core` is required to construct a simulation model. -A `odcsim-engine-*` package is needed for running the simulation -model. - -#### Gradle -Groovy -```groovy -implementation 'com.atlarge.odcsim:odcsim-api:2.0.0' -runtime 'com.atlarge.odcsim:odcsim-engine-omega:2.0.0' -``` -Kotlin -```groovy -implementation("com.atlarge.odcsim:odcsim-api:2.0.0") -runtime("com.atlarge.odcsim:odcsim-engine-omega:2.0.0") -``` - -#### Maven -```xml -<dependency> - <groupId>com.atlarge.odcsim</groupId> - <artifactId>odcsim-api</artifactId> - <version>2.0.0</version> -</dependency> - -<dependency> - <groupId>com.atlarge.odcsim</groupId> - <artifactId>odcsim-engine-omega</artifactId> - <version>2.0.0</version> -</dependency> -``` - |