.. _main_index: Zoe Analytics - Container-based Analytics as a Service ====================================================== Zoe Analytics provides a simple way to provision data analytics applications. It hides the complexities of managing resources, configuring and deploying complex distributed applications on private clouds. Zoe is focused on data analysis applications, such as `Spark `_ or `Tensorflow `_. A generic, very flexible application description format lets you easily describe any kind of data analysis application. Downloading ----------- Get Zoe from the `GitHub repository `_. Stable releases are tagged on the master branch and can be downloaded from the `releases page `_. Zoe is written in Python 3.4+ and requires a number of third-party packages to function. Deployment scripts for the supported back-ends, install and setup instructions are available in the :ref:`installation guide `. Quick tutorial -------------- To use the Zoe command-line interface, first of all you have to create a configuration file called ``~/.zoerc`` containing your login information:: url=http://localhost:5000 # address of the zoe-api instance user=joe # User name pass=joesecret # Password Now you can check if you are up and running with this command:: ./zoe.py info It will return some version information, by querying the zoe-api and zoe-master processes. Zoe applications are passed as JSON files. A few sample ZApps are available in the ``contrib/zapp-shop-sample/`` directory. To start a ZApp use the following command:: ./zoe.py start joe-spark-notebook contrib/zapp-shop-sample/jupyter-r/r-notebook.json ZApp execution status can be checked this way:: ./zoe.py exec-ls # Lists all executions, past and present ./zoe.py exec-get # Inspects an execution Where ``execution id`` is the ID of the ZApp execution to inspect, taken from the ``exec-ls`` command. Or you can just connect to the web interface (port 5001 by default). Where to go from here --------------------- Main documentation ^^^^^^^^^^^^^^^^^^ .. toctree:: :maxdepth: 1 install config_file users roles quotas logging proxy kube_backend Zoe applications ^^^^^^^^^^^^^^^^ .. toctree:: :maxdepth: 1 zapps/howto_zapp zapps/zapp_format Development and contributing to the project ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. toctree:: :maxdepth: 1 developer/index architecture contributing External resources ^^^^^^^^^^^^^^^^^^ - `Zoe Homepage `_ - `Issue tracker `_ Zoe is licensed under the terms of the Apache 2.0 license.