From c5a141af84fde0795e4a85359c7d729e93843b02 Mon Sep 17 00:00:00 2001 From: Matteo Cantarelli Date: Tue, 14 May 2019 11:49:41 +0100 Subject: [PATCH] Update README.md --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4d069d44..3253ba71 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,8 @@ If you want to build your own Geppetto application follow these [instructions](h The demo application is available in [this repository](https://github.com/openworm/geppetto-application) which you can fork to build your own. Every Geppetto application has an npm dependency on [geppetto-client](https://github.com/openworm/geppetto-client/tree/development) which makes all the frontend Geppetto components and infrastructure available to the application. A Geppetto application can be deployed on different backends based on Java (via Eclipse Virgo) or Python (via [Jupyter Notebook](https://github.com/openworm/org.geppetto.frontend.jupyter) or [Django](https://github.com/MetaCell/pygeppetto-django)). +#### Web client + [geppetto-client](https://github.com/openworm/geppetto-client/tree/development) Reused in all Geppetto applications, available from [npm](https://www.npmjs.com/package/@geppettoengine/geppetto-client) #### Java backend The Java backend is the reference backend implementation and is used in client-server deployments of Geppetto. The Java backend is modular allowing each deployment to be customised only with the relevant bundles. @@ -37,10 +39,15 @@ The Java backend is the reference backend implementation and is used in client-s * Fluid mechanics (Currently in development) * [org.geppetto.sibernetic](https://github.com/openworm/org.geppetto.sibernetic) [![Build Status](https://travis-ci.org/openworm/org.geppetto.sibernetic.png?branch=master)](https://travis-ci.org/openworm/org.geppetto.sibernetic) -#### Jupyter Geppetto Python Backend (working prototype, in development) -The Python backend is based on a Geppetto Jupyter extension which allows the user to interact with the Geppetto frontend from Python. This deployment makes it ideal to use a Geppetto application as a visualization/computational local playground. Client-server deployments are also possible using Jupyter Hub. - * [org.geppetto.frontend.jupyter](https://github.com/openworm/org.geppetto.frontend.jupyter) [![Build Status](https://travis-ci.org/openworm/org.geppetto.frontend.jupyter.png?branch=master)](https://travis-ci.org/openworm/org.geppetto.frontend.jupyter) - * [pyGeppetto](https://github.com/openworm/pygeppetto) pyGeppetto holds the common code shared in all Python backends regardless of the specific server (Django, Jupyter, etc.). pyGeppetto contains the code to work with a Geppetto model and to implement the REST and Websockets APIs. +#### Python Backend (working prototype, in development) + +Python backends are being developed both on top of [Django](https://github.com/MetaCell/pygeppetto-django) and as a [Jupyter Notebook extension](https://github.com/openworm/org.geppetto.frontend.jupyter). The Jupyter extension allows the user to host a Geppetto application inside a Jupyter Notebook environment. The application will talk to the Python kernel of the notebook which will act as a backend. Client-server deployments based on the Jupyter Notebook extension are also possible using Jupyter Hub. + + * [org.geppetto.frontend.jupyter](https://github.com/openworm/org.geppetto.frontend.jupyter) + +All Python backends will reuse pyGeppetto as the main library. pyGeppetto contains the code to work with a Geppetto model and to implement the REST and Websockets APIs which is independent of the specific server (e.g., Django, Jupyter, etc.). + + * [pyGeppetto](https://github.com/openworm/pygeppetto) #### Node.js Backend (proof of concept) * [org.geppetto.frontend.nodejs](https://github.com/openworm/org.geppetto.frontend.nodejs) [![Build Status](https://travis-ci.org/openworm/org.geppetto.frontend.nodejs.png?branch=master)](https://travis-ci.org/openworm/org.geppetto.frontend.nodejs)