Metadata-Version: 2.1
Name: vmon-cli
Version: 0.2.0
Summary: CLI Viewer for Ibsen 512 USB interrogator
Home-page: https://github.com/codenio/vmon-cli
Author: Aananth K
Author-email: aananthraj1995@gmail.com
License: GPL-3.0
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: click (==7.1.2)
Requires-Dist: cycler (==0.10.0)
Requires-Dist: DateTime (==4.3)
Requires-Dist: kiwisolver (==1.3.1)
Requires-Dist: matplotlib (==3.3.3)
Requires-Dist: numpy (==1.19.4)
Requires-Dist: pandas (==1.1.5)
Requires-Dist: Pillow (==8.0.1)
Requires-Dist: pyparsing (==2.4.7)
Requires-Dist: python-dateutil (==2.8.1)
Requires-Dist: pytz (==2020.4)
Requires-Dist: scipy (==1.5.4)
Requires-Dist: six (==1.15.0)
Requires-Dist: zope.interface (==5.2.0)


# vmon-cli

vmon-cli - CLI Viewer for Ibsen 512 USB interrogator


## Installation

```bash
# clone the repository
$ git clone git@github.com:codenio/vmon-cli.git

# move into tmon-cli folder
$ cd vmon-cli

# install requirements
$ pip install -r requirments.txt

# intall tmon
$ pip install .

# check installation
$ vmon --help
Usage: vmon [OPTIONS] COMMAND [ARGS]...

  vmon - I-Mon Spectrum Viewer and Exporter

Options:
  --help  Show this message and exit.

Commands:
  export  Export Processed I-Mon data read from <file>.csv into...
  plot    Plot the I-Mon data into graphs
```

### Usage

- vmon commands
    ```bash
    vmon --help
    Usage: vmon [OPTIONS] COMMAND [ARGS]...

      vmon - I-Mon Spectrum Viewer and Exporter

    Options:
      --help  Show this message and exit.

    Commands:
      export  Export Processed I-Mon data read from <file>.csv into...
      plot    Plot the I-Mon data into graphs
    ```
- plot sub command
    ```bash
    $ vmon plot --help
    Usage: vmon plot [OPTIONS] FILES...

      Plot the I-Mon data into graphs

    Options:
      -p, --path TEXT   path form which csv files are to be imported, default = .
      -t, --title TEXT  set custom title for the plot, default = .
      -n, --normalise   normalise the data before ploting
      -pk, --peaks      show peaks in the plot
      --help            Show this message and exit.
    ```

- export sub command
    ```bash
    $ vmon export --help
    Usage: vmon export [OPTIONS] [FILES]...

      Export Processed I-Mon data read from <file>.csv into <file>_vmon.csv
      files

    Options:
      -p, --path TEXT  path form which csv files are to be imported, default = .
      -n, --normalise  normalise the data before ploting
      -i, --inspect    inspect the plot before exporting
      --help           Show this message and exit.
    ```


