summaryrefslogtreecommitdiff
path: root/docs/configuring.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuring.rst')
-rw-r--r--docs/configuring.rst32
1 files changed, 18 insertions, 14 deletions
diff --git a/docs/configuring.rst b/docs/configuring.rst
index 867722e..02bce68 100644
--- a/docs/configuring.rst
+++ b/docs/configuring.rst
@@ -2,27 +2,31 @@
Configuring the backend
============================
-Currently there are two backends available: The one included in pyvisa which
-uses the NI library. This is used by default and the configuration is described
-in the next chapter.
-And then there is pyvia-py a pure python implementation of the VISA libary.
-It can be selected by passing a parameter to the ResourceManager:
+
+Currently there are two backends available: The one included in pyvisa, which
+uses the NI library, and the backend provided by pyvisa-py, which is a pure python implementation of the VISA library.
+If no backend is specified, pyvisa uses the NI backend if the NI library has been installed (see next section for details). Failing that, it uses the pyvisa-py backend.
+
+You can also select a desired backend by passing a parameter to the ResourceManager, shown here for pyvisa-py:
>>> visa.ResourceManager('@py')
-Alternativly it can also be selected by setting the environment variable
+Alternatively it can also be selected by setting the environment variable
PYVISA_LIBRARY. It takes the same values as the ResourceManager constructor.
Configuring the NI backend
==========================
-.. note:: The NI backend requires that you install first the NI-VISA library. You can get
- info here: (:ref:`getting_nivisa`)
+.. note::
+
+ The NI backend requires that you install first the NI-VISA library. You can
+ get info here: (:ref:`getting_nivisa`)
-In most cases PyVISA will be able to find the location of the shared visa library.
-If this does not work or you want to use another one, you need to provide the library
-path to the :class:`pyvisa.highlevel.ResourceManager` constructor::
+In most cases PyVISA will be able to find the location of the shared visa
+library. If this does not work or you want to use another one, you need to
+provide the library path to the :class:`pyvisa.highlevel.ResourceManager`
+constructor::
>>> rm = ResourceManager('Path to library')
@@ -65,9 +69,9 @@ You can define a site-wide configuration file at
Under Windows, this file is usually placed at
:file:`c:\\Python27\\share\\pyvisa\\.pyvisarc`.
-If you encounter any problem, take a look at the :ref:`faq`. There you will find the
-solutions to common problem as well as useful debugging techniques. If everything fails,
-feel free to open an issue in our `issue tracker`_
+If you encounter any problem, take a look at the :ref:`faq`. There you will
+find the solutions to common problem as well as useful debugging techniques. If
+everything fails, feel free to open an issue in our `issue tracker`_
.. _`home directory`: http://en.wikipedia.org/wiki/Home_directory
.. _`issue tracker`: https://github.com/pyvisa/pyvisa/issues