OpenDC Simulator
Collaborative Datacenter Simulation and Exploration for Everybody
## Introduction
This repository hosts the source code and development of the simulation component of the [OpenDC](https://opendc.org) project. This component is responsible for modelling and simulation of datacenters and their components. We have structured the repository into two individual subprojects:
- **[odcsim](/odcsim)**
A framework for discrete event simulation using the [Kotlin](https://kotlinlang.org/) language.
- **[opendc](/opendc)**
A collection of models for simulating clouds, datacenters and their components using the **odcsim** framework.
## Documentation
Check out the [Getting Started](#getting-started) section for a quick
overview.
The documentation is located in the [docs/](docs/) directory and is divided as follows:
1. [Toolchain Setup](docs/setup.md)
2. [Architecture Overview](docs/architecture.md)
3. [Pre-built Models](docs/models.md)
4. [Running a Model](docs/run.md)
5. [Building Your Own Model](docs/build.md)
6. [API Reference](https://atlarge-research.github.io/opendc-simulator) **(TODO maybe remove this until we have created this - see #36)**
## Contributing
### Contributing Guide
Read our [contributing guide](CONTRIBUTING.md) to learn about our
development process, how to propose bug fixes and improvements, and how
to build and test your changes to the project.
### License
The OpenDC simulator is available under the [MIT license](https://github.com/atlarge-research/opendc-simulator/blob/master/LICENSE.txt).