README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

<a href="https://opendc.org/">
    <img src="https://opendc.org/img/logo.png" alt="OpenDC logo" title="OpenDC" align="right" height="100" />
</a>

# OpenDC

Collaborative Datacenter Simulation and Exploration for Everybody

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](/LICENSE.txt)
[![Documentation](https://img.shields.io/badge/docs-master-green.svg)](https://atlarge-research.github.io/opendc)
[![GitHub release](https://img.shields.io/github/v/release/atlarge-research/opendc?include_prereleases)](https://github.com/atlarge-research/opendc/releases)
[![Build](https://github.com/atlarge-research/opendc/actions/workflows/build.yml/badge.svg)](https://github.com/atlarge-research/opendc/actions/workflows/build.yml)

-----

This repository is the home of the OpenDC project, a free and open-source platform for cloud datacenter simulation.

## Latest Release

All releases of OpenDC can be found [here](https://github.com/atlarge-research/opendc/releases).
The latest release will be marked _latest_.

## Documentation

You can find the OpenDC documentation [on the website](https://atlarge-research.github.io/opendc/).
The documentation is divided into several sections:

* [Getting Started](https://atlarge-research.github.io/opendc/docs/category/getting-started/)
* [Tutorials](https://atlarge-research.github.io/opendc/docs/category/tutorials/)
* [Advanced Guides](https://atlarge-research.github.io/opendc/docs/category/advanced-guides/)
* [Where to Get Support](https://atlarge-research.github.io/opendc/community/support/)
* [Contributing Guide](https://atlarge-research.github.io/opendc/community/contributing/)

The source code for the documentation is located in the [gh-pages branch](https://github.com/atlarge-research/opendc/tree/gh-pages).
Push to that branch to update the documentation.

## Contributing

Questions, suggestions and contributions are welcome and appreciated!
Please refer to the [contributing guidelines](CONTRIBUTING.md) for more details.

## License

OpenDC is distributed under the MIT license. See [LICENSE.txt](/LICENSE.txt).