vix_utils icon indicating copy to clipboard operation
vix_utils copied to clipboard

Documentation - Add Some

Open dougransom opened this issue 3 years ago • 2 comments

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

dougransom avatar Mar 13 '23 14:03 dougransom

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 :)

AQuant206 avatar Mar 24 '23 03:03 AQuant206

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.

dougransom avatar Mar 25 '23 15:03 dougransom