From d5ca9cfe719699f44076ca371d25d0946aefb380 Mon Sep 17 00:00:00 2001 From: bd Date: Sun, 14 Dec 2025 03:20:35 -0500 Subject: README: Update with brief instructions on how to run. --- README | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README b/README index ff734e6..4cf2fad 100644 --- a/README +++ b/README @@ -5,3 +5,12 @@ coroutines through use of [[https://github.com/plasma-umass/coz][causal profilin optimization potential without instrumentation by predicting the impact of how coroutine optimization has an inpact on the overall throughput or latency of tasks scheduled in the event loop. + +In order to try Nemesis, you need to specify the =loop= argument of +the =asyncio.run= method to the CausalEventLoop class. See the examples +folder for information on how to do this. In python versions older than +3.14, the canonical way to use a custom event loop is to set the [[https://docs.python.org/3/library/asyncio-policy.html][default +loop policy]]. + +As Nemesis only works for the =asyncio.SelectorEventLoop= class, it is only +usable for GNU/Linux or Mac systems. -- cgit v1.2.3