diff options
Diffstat (limited to 'docs/architecture.md')
| -rw-r--r-- | docs/architecture.md | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/architecture.md b/docs/architecture.md index a854bf6d..60ac3e0d 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -1,8 +1,17 @@ -# 2. Architecture Overview +# 3. Architecture Overview + +The OpenDC simulator has two main components: `odcsim`, a general framework for discrete event-based simulation, and `opendc` a collection of components using `odcsim` to simulate datacenters. We discuss both in turn! + +`TODO: Add a schematic general overview here.` + +## 3.1 `odcsim` + + +## 3.2 `opendc` **TODO: What are the main components (odcsim-core, odcsim-engine, opendc-core, opendc-format, opendc-testkit, opendc-workflows, I assume)? Short description of each in a bullet list (or even a schema drawing, if you have the time). Why this division?** **TODO: One section per component, explaining what their responsibility is and what other modules they talk to. In what kind of scenarios do you as OpenDC developer need to touch/change them?** --- -[< Previous](setup.md) | [Next >](models.md) +[< Previous](setup.md) | [Next >](run.md) |