Metadata-Version: 2.1
Name: pymanip
Version: 0.4.3
Summary: Python framework for experiments
Home-page: https://pypi.org/project/pymanip/
Author: Julien Salort
Author-email: julien.salort@ens-lyon.fr
License: CeCILL-B
Project-URL: Documentation, https://pymanip.readthedocs.io/en/latest/
Project-URL: Source Code, https://github.com/jsalort/pymanip
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
License-File: LICENSE.txt

|Build Status| |PyPI version| |Documentation Status|

pymanip
=======

Description and goals
---------------------

pymanip is the main package that we use for data acquisition and
monitoring of our experimental systems in the Convection group at
`Laboratoire de physique de l’ENS de
Lyon <http://www.ens-lyon.fr/PHYSIQUE>`__. It can be seen as an
extension of the
`FluidLab <https://foss.heptapod.net/fluiddyn/fluidlab>`__ module, which
it heavily uses. It is available freely under the French `CECILL-B
license <https://cecill.info/licences/Licence_CeCILL-B_V1-en.html>`__ in
the hope that it can be useful to others. But it is provided AS IS,
without any warranty as to its commercial value, its secured, safe,
innovative or relevant nature.

Unlike FluidLab, pymanip does not garantee any long term stability, and
may change the API in the future without warning. However, some parts of
the pymanip module may eventually be integrated into FluidLab, once they
are stable enough.

The pymanip module is a set of tools for data acquisition and data
management. Its goals are the following:

-  management of experimental “sessions”, for storing and retriving
   data, and useful live tools for experimental monitoring over long
   times, such as live plot, automated emails, and remote access of the
   live data, and also simple interrupt signal management;
-  simplify access to FluidLab instrument classes;
-  experimental implementation of asynchroneous video acquisition and
   DAQ acquisition;
-  experimental extension of FluidLab interface and instrument classes
   with asynchroneous methods;
-  miscellaneous CLI tools for saved session introspection, live video
   preview, live oscilloscope and spectrum analyser-style DAQ preview,
   and VISA/GPIB scanning.

Documentation
-------------

The documentation is available at
`readthedocs <https://pymanip.readthedocs.io/en/latest/>`__.

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

The package can be installed from
`pypi <https://pypi.org/project/pymanip/>`__ using ``pip``:

::

   python -m pip install pymanip

or can be installed from github

::

   git clone https://github.com/jsalort/pymanip.git
   cd pymanip
   python -m pip install -e .

.. |Build Status| image:: https://travis-ci.com/jsalort/pymanip.svg?branch=master
   :target: https://travis-ci.com/jsalort/pymanip
.. |PyPI version| image:: https://badge.fury.io/py/pymanip.svg
   :target: https://badge.fury.io/py/pymanip
.. |Documentation Status| image:: https://readthedocs.org/projects/pymanip/badge/?version=latest
   :target: https://pymanip.readthedocs.io/en/latest/?badge=latest


