ooepics 2.0.1

Python framework for soft IOC.

ooEpicsPy

ooEpicsPy is a Python version of ooEpics (https://github.com/aaqiao/ooEpics) aiming at developing soft IOCs. Base classes are provided to skeleton EPICS soft IOCs, mainly or middle-layer application servers. ooEpicsPy provides the following features:

• EPICS database can be created by creating objects of LocalPVs in the user code.
• Basic Channel Access functions (e.g. caget, caput, camonitor, w/o callbacks …) are wrapped by the RemotePV class based on the PyEpics module.
• Provides base classes to implement finite state machines.
• Provides an active Application class to execute user command driven jobs.
• Provides an example soft IOC code in the folder example.

Dependencies

ooEpicsPy depends on the following non-standard Python modules:

• PyEpics: https://pyepics.github.io/pyepics/

Installation

The ooEpicsPy software should be installed to your Python environment. To install the released version, use the following command: pip install ooepics To install from the source code, follow the steps below:

• Clone this repository to your working folder.
• Check out the tag you want to install, or directly install the head (may contain debug code).
• In the top folder where the setup.py is stored, execute the command below to make the installation.

  pip install .
  

Documentation

• UML class diagram
• Class documentation
• Example soft IOC documentation

Disclaimer (see the LICENSE file)

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.