From c8e1dbcbdde3f4d3212f19a8fe0f7cccd827b2ab Mon Sep 17 00:00:00 2001 From: TT Date: Sun, 18 Aug 2019 10:48:27 +0900 Subject: [PATCH] doc: separate python README --- README.md | 26 +------------------------- python/README.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 25 deletions(-) create mode 100644 python/README.md diff --git a/README.md b/README.md index f8a5671..d48e995 100644 --- a/README.md +++ b/README.md @@ -78,31 +78,7 @@ Then, burn firmware using dfu-util via USB. ## Control from PC -NanoVNA is able to work standalone, but also be controlled via USB serial interface from PC. There are sample scripts in python directory. - -Preparation. - - $ pip install numpy - $ pip install scikit-rf - -Plot reflection LOGMAG. - - $ cd python - $ ./nanovna.py -p - -Plot transmission LOGMAG. - - $ ./nanovna.py -p -P 1 - -Plot smithchart. - - $ ./nanovna.py -s - -Show usage. - - $ ./nanovna.py -h - -To use NanoVNA from Jupyter notebook, see [this page](/python/NanoVNA-example.ipynb). +See [python directory](/python/README.md). ## Note diff --git a/python/README.md b/python/README.md new file mode 100644 index 0000000..1c04702 --- /dev/null +++ b/python/README.md @@ -0,0 +1,31 @@ +# Control NanoVNA from python script + +NanoVNA is able to be controlled via USB serial interface from PC. There are sample scripts in this directory. + +## Preparation + + $ cd python + $ pip install numpy + $ pip install scikit-rf + +## Run + +### Plot reflection LOGMAG. + + $ ./nanovna.py -p + +### Plot transmission LOGMAG. + + $ ./nanovna.py -p -P 1 + +### Plot smithchart. + + $ ./nanovna.py -s + +### Show usage. + + $ ./nanovna.py -h + +## Using in Jupyter Notebook + +To use NanoVNA from Jupyter notebook, see [this page](/python/NanoVNA-example.ipynb).