search

dougransom / vix_utils

vix_utils provides command line tools and a a Python API for preparing data for analysing the VIX Futures and Cash Term structures. Term Structure data can be exported to excel (.xslx), csv, and pickle formats.
MIT License
41 stars 9 forks source link

Documentation - Add Some #15

Open dougransom opened 1 year ago

dougransom commented 1 year ago

Instead of just the examples and readme.md, some documentation on how to use would be expected.

AQuant206 commented 1 year ago

What is the command line equivalent of -r so I can use/run src\examples\sample_plots.py?

Goal is to display the cash term structure with 1st, 2nd, etc month futures values (VX1, VX2, ...) using data pulled by vix_util.

3-24 Add: I was able to successfully run examples\sample_plots.py. That said its comments state you need to first run vixutil -r to download data which wasn't true with this version. That's a sample/comment bug. Updating docs to reflect there is now no -r command line option would be a plus :)

dougransom commented 1 year ago

What is the command line equivalent of -r so I can use/run src\examples\sample_plots.py?

Goal is to display the cash term structure with 1st, 2nd, etc month futures values (VX1, VX2, ...) using data pulled by vix_util.

3-24 Add: I was able to successfully run examples\sample_plots.py. That said its comments state you need to first run vixutil -r to download data which wasn't true with this version. That's a sample/comment bug. Updating docs to reflect there is now no -r command line option would be a plus :)

I removed the comment at line 2 of the file. If there is more to it than that please add a comment to https://github.com/dougransom/vix_utils/issues/17.