Skip to main content

Implementation of virtual MODI modules written in Python.

Project description

VirtualMODI

Python Versions Release (PyPI) Build Workflow Status (Github Actions) CodeFactor Grade GitHub LICENSE Lines of Code

Description

Implementation of virtual MODI modules, written in Python.

Features

VirtualMODI mimics the operation of MODI HW modules.

  • Performs message generation and destruction for MODI1 and 2 modules
  • Provides MPI through various connections including serial and TCP

How to Install

When installing VirtualMODI package, we highly recommend you to use Anaconda to manage the distribution. With Anaconda, you can use an isolated virtual environment, solely for VirtualMODI.

[Optional] Once you install Anaconda, then:

# Install new python environment for VirtualMODI package, choose python version >= 3.6
conda create --name virtual-modi python=3.6

# After you properly install the python environment, activate it
conda activate virtual-modi

# Make sure that your python version is compatible with VirtualMODI
python --version

Install the latest version of VirtualMODI:

python -m pip install virtual-modi --user

How to Use

Import virtual-modi package and create VirtualBundle object.

from virtual_modi import VirtualBundle
vb = VirtualBundle()

When creating the bundle object, you can optionally pass configuration parameters.

vb = VirtualBundle(conn_type='ser', modi_version=1)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

virtual-modi-0.3.1.tar.gz (12.9 kB view hashes)

Uploaded source

Built Distribution

virtual_modi-0.3.1-py3-none-any.whl (19.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page