Skip to content

Home

Model Insertion CLI (MIC) is a command-line interface for adding models on a Model Catalog Service.

MIC is an application that will guide you through the steps required for encapsulating your model component and exposing a set of inputs and parameters of interest. MIC also allows describing basic model metadata: model version, model configuration, parameters, inputs, outputs, authors and contribuors.

MIC has been tested in OSX, Linux and Windows. It is installed through a simple pip command.

Info

MIC is an ALPHA version, which we are still testing and developing continuously. If you find an error or experience any issue, please report them here.

Requirements

MIC has the following requirements:

  1. Python >= 3.6
  2. Docker

Python 3

DAME uses Python. Please, follow the steps bellow to install it:

Docker

MIC uses Docker test and run model components.

Installation

To install MIC, open a terminal and run:

$ pip install mic

You did it! If you want to verify the installation just type:

$ mic version

You should see a message similar to:

mic v1.0.1

Limitations

Note that MIC has been designed to run Unix-based applications. Windows based applications (e.g., models that execute through an .exe) are not currently supported.

Development version

If you want to install the latest development version, open a terminal and type:

$ pip install git+https://github.com/mintproject/mic.git@develop -U

Note theat the development version may be unstable.

Issues, Troubleshooting and Feature Requests

Known issues with MIC are listed here.

If you experience any issues when using MIC, or if you would like us to support additional exciting features, please open an issue on our GitHub repository.

Code Releases and Next Updates

The latest release of MIC is available in GitHub. You can check the issues and updates we are working on for the next releases here.