VIRLSDK(1)

NAME
virlsdk - virlsdk 0.1.post0.dev1+ng910c7a3.dirty

This is the documentation of virlsdk.

NOTE: This is the main page of your project's Sphinx documentation. It is formatted in reStructuredText. Add additional pages by creating rst-files in docs and adding them to the toctree below. Use then references in order to link them from this page, e.g. authors and changes.

It is also possible to refer to the documentation of other Python packages with the Python domain syntax. By default you can reference the documentation of Sphinx, Python, NumPy, SciPy, matplotlib, Pandas, Scikit-Learn. You can add more by extending the intersphinx_mapping in your Sphinx's conf.py.

The pretty useful extension autodoc is activated by default and lets you include documentation from docstrings. Docstrings can be written in Google (recommended!), NumPy and classical style.

CONTENTS

  License

Copyright 2017 Ajay Chenampara
MIT License
===========
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

  Developers

•   Ajay Chenampara <ajay.chenampara@ge.com>

  Changelog

  Version 0.1

•   Initial release

  USAGE

`pip install virlsdk should install the module` 1. launch_sim.py and stop_sim.py show how to use the virlsdk python launch_sim.py --help will show you how to use the file `python launch_sim.py -f config.yaml`

2.  The config yaml file should be populated with the details of your virl server. This will also point the code to the location of your virl file

INDICES AND TABLES

•   genindex

•   modindex

•   search

COPYRIGHT
2017, Ajay Chenampara