Skip to main content

A proactive kernel for Jupyter

Project description

# proactive-jupyter-kernel
ProActiveKernel for Jupyter

## 1. Requirements:

* Python 2 or 3

## 2. Installation:

### 2.1 Using Pypi

1) open a terminal

2) install the proactive jupyter kernel

```Bash
$ pip install proactive proactive-jupyter-kernel --upgrade
$ python -m proactive-jupyter-kernel.install
```

### 2.2 Using source code

1) open a terminal

2) clone the repository on your local machine:

```bash
$ git clone git@github.com:ow2-proactive/proactive-jupyter-kernel.git
```
3) install the proactive jupyter kernel:

```Bash
$ pip install proactive-jupyter-kernel/
$ python -m proactive-jupyter-kernel.install
```

## 3. Platform

You can use any jupyter platform.
We recommend the use of jupyter lab. To launch it from your terminal after having installed it:

```bash
$ nohup jupyter lab &>/dev/null &
```

When opened, click on the Proactive icon to open a notebook based on the proactive kernel.

## 4. Connect:

### 4.1 Using connect()

If you are trying proactive for the first time, please sign up on [try platform](https://try.activeeon.com/signup.html).
Once you receive your login and password, connect using the `#%connect()` pragma:

```python
#%connect(login=YOUR_LOGIN, password=YOUR_PASSWORD)
```

To connect to another host, use the later pragma this way:

```python
#%connect(host=YOUR_HOST, port=YOUR_PORT, login=YOUR_LOGIN, password=YOUR_PASSWORD)
```

### 4.2 Using config file:

For automatic sign in, create a file named 'proactive_config.ini' in your notebook's location.

Fill your configuration file according to the format:

```Bash
[proactive_server]
host = YOUR_HOST
port = YOUR_PORT

[user]
login = YOUR_LOGIN
password = YOUR_PASSWORD
```

Save your file changes and restart the proactive kernel.

You can also force the current Kernel to connect using any .ini config file through the `#%connect()` pragma:

```python
#%connect(path=PATH_TO/YOUR_CONFIG_FILE.ini)
```

(for more information about this format please check
[configParser](https://docs.python.org/3/library/configparser.html))

## 5. Usage

#### 5.1 Creating a Python task

To create a task, write your python implementation into a notebook block code (a default name
will be given to the created task):

```python
print('Hello world')
```

Or you can provide more information about the task by using the `#%task()` pragma:

```python
#%task(name=TASK_NAME)
print('Hello world')
```

#### 5.2 Adding a fork environment

To configure a fork environment for a task, use the `#%fork_env()` pragma. A first way to do this
is by providing the name of the corresponding task, and the fork environment implementation after that:

```python
#%fork_env(name=TASK_NAME)
containerName = 'activeeon/dlm3'
dockerRunCommand = 'docker run '
dockerParameters = '--rm '
paHomeHost = variables.get("PA_SCHEDULER_HOME")
paHomeContainer = variables.get("PA_SCHEDULER_HOME")
proActiveHomeVolume = '-v '+paHomeHost +':'+paHomeContainer+' '
workspaceHost = localspace
workspaceContainer = localspace
workspaceVolume = '-v '+localspace +':'+localspace+' '
containerWorkingDirectory = '-w '+workspaceContainer+' '
preJavaHomeCmd = dockerRunCommand + dockerParameters + proActiveHomeVolume + workspaceVolume + containerWorkingDirectory + containerName
```

A second way is by providing the name of the task, and the path of a _.py_ file containing the fork environment code:

```python
#%fork_env(name=TASK_NAME, path=./FORK_ENV_FILE.py)
```

#### 5.3 Adding a selection script

To add a selection script to a task, use the `#%selection_script()` pragma. A first way to do it,
provide the name of the corresponding task, and the selection code implementation after that:

```python
#%selection_script(name=TASK_NAME)
selected = True
```

A second way is by providing the name of the task, and the path of a .py file containing the selection code:

```python
#%selection_script(name=TASK_NAME, path=./SELECTION_CODE_FILE.py)
```

#### 5.4 Create a job

To create a job, use the `#%job()` pragma:

```python
#%job(name=JOB_NAME)
```

If the job was already been created, the call of this pragma would just rename the job already created by the new provided name.

**Notice that it is not necessary to create and name explicitly the job. If not done by the user, this step is implicitly
performed when the job is submitted (check section 5.7 for more information).**

#### 5.5 Plot job

To verify the created workflow, use the `#%draw_job()` pragma to plot it into a separate window:

```python
#%draw_job()
```

Two optional parameters can be used to configure the way the kernel plot the workflow.

* **inline plotting:**

If this parameter is set to 'off', the workflow plotting is made through the [Matplotlib](https://matplotlib.org/)
external window. The default value is 'on'.

```python
#%draw_job(inline=off)
```

* **saving into hard disk:**

To be sure the workflow is saved into a _.png_ file, this option needs to be set to 'on'. The default value is 'off'.

```python
#%draw_job(save=on)
```

Note that the job will be named (in the order of existence) by the name provided using the 'name' parameter, by the name of the job
if it is created, by the name of the notebook if reachable or at worst by "Unnamed_job".

```python
#%draw_job([name=JOB_NAME], [inline=off], [save=on])
```

#### 5.6 Save workflow in dot format

To save the created workflow into a [GraphViz](https://www.graphviz.org/) _.dot_ format, use the `#%write_dot()` pragma:

```python
#%write_dot(name=FILE_NAME)
```


#### 5.7 Submit your job to the scheduler

To submit the job to the proactive scheduler, the user has to use the `#%submit_job()` pragma:

```python
#%submit_job()
```

If the job is not created, **or** is not up-to-date, the `#%submit_job()` starts by creating a new job named as the old one.
To provide a new name, use the same pragma and provide a name as parameter:

```python
#%submit_job(name=JOB_NAME)
```

If the kernel, during its execution, never received a job name, he uses the current notebook name, if possible, or gives a random one.


#### 5.8 Printing results

To finally get the job result(s), the user has to use the `#%get_result()` pragma by providing the job name:

```python
#%get_result(name=JOB_NAME)
```

**or** by the job id:

```python
#%get_result(id=JOB_ID)
```

The returned values of your final tasks will be automatically printed in the notebook results.


Current status
----------

Features:

* help: prints all different pragmas/features of the kernel
* connect: connects to an ActiveEon server
- OPTION: connection using a configuration file
* task: creates a task
* selection_script: sets the selection script of a task
* fork_env: sets the fork environment script
* job: creates/renames the job
* draw_job: plot the workflow
* write_dot: writes the workflow in .dot format
* submit_job: submits the job to the scheduler
* get_result: gets and prints the job results


TODO:

1. check how to highlight Python syntax
2. add auto-complete
3. re-adapt the valid_pragma method to be more robust to parameters order in pragmas (parse and, then, check regular
expression of each parameter value)
4. explain dependencies handling in the README file
5. add some examples pictures to README
6. add generic_info, pre/post scripts description in README file

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
proactive-jupyter-kernel-0.1.2019.05.03.17.35.zip (18.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page