keysight 0.5.1

keysight
========

`|PyPi Version| <https://pypi.python.org/pypi/keysight>`_ `|Build
Status| <https://travis-ci.org/questrail/keysight>`_ `|Coverage
Status| <https://coveralls.io/r/questrail/keysight>`_ `|License
Badge| <https://github.com/questrail/keysight/blob/develop/LICENSE.txt>`_

`keysight <https://github.com/questrail/keysight>`_ is a Python
(2.6+/3.3+) package providing modules and helpers to work with data
files from `Keysight Technologies <http://www.keysight.com/>`_ (formerly
Agilent/HP) test equipment.

Dependencies
------------

Runtime Dependencies
~~~~~~~~~~~~~~~~~~~~

- `numpy <http://www.numpy.org>`_

Development Dependencies
~~~~~~~~~~~~~~~~~~~~~~~~

- `invoke <http://www.pyinvoke.org>`_
- `nose <http://nose.readthedocs.io/en/latest/>`_
- `unipath <https://github.com/mikeorr/Unipath>`_

Support Keysight Equipment
--------------------------

Spectrum Analyzers
~~~~~~~~~~~~~~~~~~

Below are the modules available in the keysight package and the
compatible equipment for each module:

- n9340: N9340 spectrum analyzer
- e4411b: E4411B, E4402B spectrum analyzers

Contributing
------------

Sample CSV and other data files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Currently, the only sample files tested are the CSV files from a N9340B
and E4411B spectrum analyzer. If you have other data files saved from a
Keysight/Agilent/HP piece of test equipment and are willing to share it,
please open an issue or submit a pull request to let us know.

Submitting Pull Requests
~~~~~~~~~~~~~~~~~~~~~~~~

`keysight <https://github.com/questrail/keysight>`_ is developed using
`Scott Chacon <http://scottchacon.com/about.html>`_'s `GitHub
Flow <http://scottchacon.com/2011/08/31/github-flow.html>`_. To
contribute, fork `keysight <https://github.com/questrail/keysight>`_,
create a feature branch, and then submit a pull request. `GitHub
Flow <http://scottchacon.com/2011/08/31/github-flow.html>`_ is
summarized as:

- Anything in the ``master`` branch is deployable
- To work on something new, create a descriptively named branch off of
``master`` (e.g., ``new-oauth2-scopes``)
- Commit to that branch locally and regularly push your work to the
same named branch on the server
- When you need feedback or help, or you think the brnach is ready for
merging, open a `pull
request <https://help.github.com/articles/using-pull-requests>`_.
- After someone else has reviewed and signed off on the feature, you
can merge it into master.
- Once it is merged and pushed to ``master``, you can and *should*
deploy immediately.

Testing
-------

License
-------

`keysight <https://github.com/questrail/keysight>`_ is released under
the MIT license. Please see the
`LICENSE.txt <https://github.com/questrail/keysight/blob/develop/LICENSE.txt>`_
file for more information.

.. |PyPi Version| image:: http://img.shields.io/pypi/v/keysight.svg
.. |Build
Status| image:: http://img.shields.io/travis/questrail/keysight/master.svg
.. |Coverage
Status| image:: http://img.shields.io/coveralls/questrail/keysight/master.svg
.. |License Badge| image:: http://img.shields.io/pypi/l/keysight.svg