summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--AUTHORS1
-rw-r--r--CHANGES8
-rw-r--r--LICENSE21
-rw-r--r--MANIFEST.in3
-rw-r--r--README62
5 files changed, 95 insertions, 0 deletions
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..21efa31
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1 @@
+pyvisa-py is written and maintained by Hernan E. Grecco <hernan.grecco@gmail.com>.
diff --git a/CHANGES b/CHANGES
new file mode 100644
index 0000000..188f63f
--- /dev/null
+++ b/CHANGES
@@ -0,0 +1,8 @@
+PyVISA-py Changelog
+===================
+
+
+0.1 (unreleased)
+----------------
+
+- Nothing changed yet.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..91b7fc2
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2014 PyVISA-py Authors and contributors. See AUTHORS
+
+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.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..90e603f
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,3 @@
+include README AUTHORS CHANGES LICENSE
+recursive-include pyvisa-alt *
+global-exclude *.pyc *~ .DS_Store *__pycache__* *.pyo
diff --git a/README b/README
new file mode 100644
index 0000000..f5a63e2
--- /dev/null
+++ b/README
@@ -0,0 +1,62 @@
+PyVISA-py
+=========
+
+A PyVISA backend that implements a large part of the "Virtual Instrument Software
+Architecture" (VISA_) in pure Python (with the help of some nice cross platform
+libraries python packages!).
+
+
+Description
+-----------
+
+PyVISA started as wrapper for the NI-VISA library and therefore you need to install
+National Instruments VISA library in your system. This works most of the time,
+for most people. But NI-VISA is a proprietary library that only works on certain
+systems. That is when PyVISA-py jumps in.
+
+Starting form version 1.6, PyVISA allows to use different backends. These backends can be
+dinamically loaded. PyVISA-py is one of such backends. It implements most of the methods
+for Messge Based communication (Serial/USB/GPIB/Ethernet) using Python and some well developed,
+easy to deploy and cross platform libraries
+
+.. _VISA: http://www.ivifoundation.org/Downloads/Specifications.htm
+
+
+VISA and Python
+---------------
+
+Python has a couple of features that make it very interesting for measurement controlling:
+
+- Python is an easy-to-learn scripting language with short development cycles.
+- It represents a high abstraction level [2], which perfectly blends with the abstraction
+ level of measurement programs.
+- It has a very rich set of native libraries, including numerical and plotting modules for
+ data analysis and visualisation.
+- A large set of books (in many languages) and on-line publications is available.
+
+
+Requirements
+------------
+
+- Python (tested with 2.6 and 2.7, 3.2+)
+- PyVISA 1.6+
+
+Optionally
+- PySerial (to interface with Serial instruments)
+- PyUSB (to interface with USB instruments)
+- linux-gpib (to interface with gpib instruments, only on linux)
+
+
+Installation
+--------------
+
+Using pip:
+
+ $ pip install pyvisa-py
+
+
+
+Documentation
+--------------
+
+The documentation can be read online at https://pyvisa-py.readthedocs.org