summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFabian Mastenbroek <mail.fabianm@gmail.com>2022-11-13 18:16:19 +0000
committerGitHub <noreply@github.com>2022-11-13 18:16:19 +0000
commit52eed48441693149993db79b63431b99e0973027 (patch)
treeba267db531bc3d81409ddfe9caeb6d3b5a65e8c8 /README.md
parent183cfa96910ebb74c668dea7ef98071966f8fcb9 (diff)
parent33d91ef30ad7bcb73365934fe536461210d1082a (diff)
merge: Increase minimum Java version to 17 (#115)
This pull request increases the minimum version of Java required by OpenDC to 17. This new version of Java introduces several new features compared to our old minimum version (11), which we attempt to apply in this conversion. ## Implementation Notes :hammer_and_pick: * Increase minimum Java version to Java 17 * Use RandomGenerator as randomness source * Add common dispatcher interface * Add compatibility with Kotlin coroutines * Use InstantSource as time source * Re-implement SimulationScheduler as Dispatcher * Replace use of CoroutineContext by Dispatcher ## External Dependencies :four_leaf_clover: * Java 17 ## Breaking API Changes :warning: * The use of `CoroutineContext` and `Clock` as parameters of classes has been replaced by the `Dispatcher` interface. * The use of `Clock` has been replaced by `InstantSource` which does not carry time zone info. * The use of `Random` and `SplittableRandom` as parameter type has been replaced by `RandomGenerator`
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 10 insertions, 29 deletions
diff --git a/README.md b/README.md
index a633b264..a82848bb 100644
--- a/README.md
+++ b/README.md
@@ -13,42 +13,23 @@ Collaborative Datacenter Simulation and Exploration for Everybody
-----
-OpenDC is a free and open-source platform for datacenter simulation aimed at both research and education.
+This repository is the home of the OpenDC project, a free and open-source platform for cloud datacenter simulation.
-![Datacenter construction in OpenDC](site/src/components/HomepageFeatures/screenshot-construction.png)
+## Latest Release
-Users can construct datacenters (see above) and define portfolios of scenarios (experiments) to see how these
-datacenters perform under different workloads and schedulers (see below).
-
-![Datacenter simulation in OpenDC](site/src/components/HomepageFeatures/screenshot-construction.png))
-
-The simulator is accessible both as a ready-to-use website hosted by us at [app.opendc.org](https://app.opendc.org), and
-as source code that users can run locally on their own machine or via Docker.
-
-To learn more
-about OpenDC, have a look through our paper [OpenDC 2.0](https://atlarge-research.com/pdfs/ccgrid21-opendc-paper.pdf)
-or on our [vision](https://atlarge-research.com/pdfs/opendc-vision17ispdc_cr.pdf).
-
-🛠 OpenDC is a project by the [@Large Research Group](https://atlarge-research.com).
-
-🐟 OpenDC comes bundled
-with [Capelin](https://repository.tudelft.nl/islandora/object/uuid:d6d50861-86a3-4dd3-a13f-42d84db7af66?collection=education)
-, the capacity planning tool for cloud datacenters based on portfolios of what-if scenarios. More information on how to
-use and extend Capelin coming soon!
+- General Availability (GA): [OpenDC v2.0](https://github.com/atlarge-research/opendc/releases/tag/v2.0) (May 10, 2021)
+- Preview (Release Candidate): n/a
## Documentation
-You can find the OpenDC documentation [on the website](https://opendc.org/).
-
-Check out the [Getting Started](https://opendc.org/docs/getting-started.html) page for a quick overview.
-
+You can find the OpenDC documentation [on the website](https://atlarge-research.github.io/opendc/).
The documentation is divided into several sections:
-* [Main Concepts](https://opendc.org/docs/category/getting-started)
-* [Tutorials](https://opendc.org/docs/category/tutorials)
-* [Advanced Guides](https://opendc.org/docs/category/advanced-guides)
-* [Where to Get Support](https://opendc.org/community/support)
-* [Contributing Guide](https://opendc.org/community/contributing)
+* [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 [site](site).