diff --git a/README.md b/README.md index 04feff9..66aa5ca 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,39 @@ This is the kernel code of the online analyzer - Blackbox Mate Online, AKA BBM. ## How to run those scripts? -1. Download and install Anaconda -2. Download this repo +1. Install Jupyter Notebook +2. Download this repo and install all the dependency packages 3. Run .ipynb files 4. Then just enjoy each cell! -Optional: install jyputer notebook extension in VSCode + + +Optional: +1. Download and install Anaconda +2. Install jyputer notebook extension in VSCode +3. Then enjoy each cell in VSCode! + +## Dependency + +- numpy +- matplotlib +- pandas +- scipy +- os +- ## Credit -This tool/script is strongly inspired by Brian White's [PIDtoolbox](https://github.com/bw1129/PIDtoolbox) and Plasmatree's [PID-analyzer](https://github.com/Plasmatree/PID-Analyzer), so here I want to pay them my highest respect! +This tool/script is strongly inspired by [PID-Analyzer](https://github.com/Plasmatree/PID-Analyzer) and [PIDtoolbox](https://github.com/bw1129/PIDtoolbox), so thanks goes to all those whom have contributed to PID-analyzer and PIDtoolbox. + +Origins for this repo (Thanks!): + +- Plasmatree (for PID-Analyzer), +- Brian White (for PIDtoolbox), +- ColinNiu (for pyPIDtoolbox) + +Big thanks to current and past contributors: + +- Chiang, Hugo (DusKing) - optimizing many details to make it scientific and usable +- ColinNiu - for the surprising framework +- Pawn, David (pdw) - for the massive testing job