From b2363b595099ca99fb66ae03f5c626a8cbc38e9f Mon Sep 17 00:00:00 2001 From: morgan Date: Tue, 7 May 2024 16:27:52 +0800 Subject: [PATCH] doc: update README to include freqsim --- README.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index be5c216..21ca94f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # WRPLL simulation -A time domain simulation for WRPLL +Frequency and time domain simulation for WRPLL ## Installation @@ -22,14 +22,10 @@ nix develop ``` ## Quick start -- Three notebook examples are included - 1. `helper_PLL_example.ipynb` : helper PLL only - 2. `main_PLL_example.ipynb` : main PLL only with a user specific helper frequency - 3. `both_PLL_example.ipynb` : main and helper PLL - -- RAM usage and execution time estimate for simulation **ONLY** - +- The simulation file is located at `src` +- RAM usage and execution time estimate for time domain simulation - 500,000,000 time steps: 8GiB RAM and 55 seconds +- Frequency domain doc is also [available](./doc/freqsim.md)
WRPLL formulas