.. HFSS Lib documentation master file, created by
   sphinx-quickstart on Mon May  4 09:10:20 2015.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to HFSS Lib's documentation!
====================================

HFSS Lib is a set of tools for manipulating HFSS files.  The central use case
is when you want to change your project design parameters based on frequency.
This guide covers both:

- General approach to scripting HFSS
- Using this library to script HFSS

If you have never scripted HFSS before (or are new to this project), start
reading the :doc:`introduction </intro>`.  If you are writing a script in
Python to make to make changes, you can find API documentation at
:doc:`hfsslib </modules>` or examples at :doc:`Python Examples</python_examples>`.

Corrections and enhancements to the docs are welcome!  The source_ is on the
ARRC's Gitlab.  Feel free to make a fork or `create an issue`_.

Installation
------------

To install the Python library, open up a command prompt and type:

.. code:: sh

    pip install hfsslib

Now you're off to the races.


Contents
--------

.. toctree::
    :maxdepth: 2

    intro.rst
    hfss_examples.rst
    matlab_examples.rst
    python_examples.rst
    modules.rst

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. _source: http://git.arrc.ou.edu/pier3595/hfss-lib
.. _create an issue: http://git.arrc.ou.edu/pier3595/hfss-lib/issues