M-Labs
/
wrpll-simulation
4
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

doc: update README to include freqsim

This commit is contained in:
morgan 2024-05-07 16:27:52 +08:00
parent b86b6a5659
commit b2363b5950
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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)
<br>
<details><summary><b>WRPLL formulas</b></summary>