Giter Site home page Giter Site logo

sot-ipython-connection's Introduction

sot_ipython_connection

The purpose of this package is to implement a flexible connection between the Stack of Tasks and a client controlling it. sot-ipython-connection makes the entire python language available to the user in order to communicate with the SoT.

Install

TODO

Overview

sot-ipython-connection has two main parts: SOTKernel and SOTClient, which are based on the ipython kernel and client and implement functionalities specific to the use of the SoT.

The kernel is a python interpreter which will be running on the robot processor, and which will contain the SoT. One or several clients can be run on separate computers, to allow users to handle the robot.

Executables

Two executables are made available in this package: sot-interpreter and sot-script-executer.

sot_interpreter

This is the kernel to run on the robot’s processor. To launch it, use the following command:

python3 ./sot_interpreter

Figure 1: sot-interpreter running

To interact with it, you have to use a client. To launch a terminal-based client that will connect with this kernel, use the following command, after launching the kernel:

jupyter console --existing

The --existing option means that the client will connect to the latest running kernel. In the case of sot_interpreter, there can be only one running at a time on the same computer, as several sot_interpreters would use the same ports.

Figure 2: Example of interactions with a jupyter console

sot_script_executer

This is a client that allows the user to execute python scripts on the kernel:

python3 ./sot_script_executer pathToScript1 [pathToScript2] [--local]

If you wish to execute several scripts, add them to the command in the order you want them to be executed. For instance, in the above command, script1 will be executed before script2.

Use the –local option if the scripts to execute are located on the same machine as the client. Otherwise, they will be considered to be on the same machine as the kernel.

sot-ipython-connection's People

Contributors

justinefricou avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

justinefricou

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.