Merge pull request #114 from ORNL/ketan-doc-format

Ketan doc format

docs/pitch.txt

@@ -1,2 +1,4 @@
 # Elevator pitch for Zambeze
 
+Zambeze is a distributed task orchestration system to orchestrate science application tasks across the large-scale and edge computing systems.
+

docs/source/getting_started.rst

@@ -2,9 +2,26 @@ Getting Started
 ===============
 
 In order to set up and start using Zambeze, you will need the following dependencies:
- * A running rabbitmq server, see `rabbitmq documentation <https://www.rabbitmq.com/documentation.html>`_.
- * Python >= 3.7. We suggest using `Anaconda <https://www.anaconda.com>`_.
+ * A running rabbitmq server, see `rabbitmq documentation <https://www.rabbitmq.com/documentation.html>`_. RabbitMQ does not need admin privileges to install and run on Linux systems.
+ * Python >= 3.9. We suggest using `Anaconda <https://www.anaconda.com>`_.
  * (Optional) ImageMagick to try a first mock example use-case. It is available `here <https://imagemagick.org/>`_.
 
-Installing Zambeze 
--------------------
+Installing and Testing Zambeze 
+------------------------------
+
+1. Checkout or Download the latest release from the `Github <https://github.com/ORNL/zambeze>`_.
+2. From the terminal in the zambeze directory run the following:
+
+   `pip install -e .`
+
+3. Ensure that you have a RabbitMQ server is running and you are able to reach it. You may verify this by telnet'ing the rabbitmq server like so:
+
+   `telnet <rabbitmq.server> 5672`
+
+4. Navigate to the examples directory and run the python program `imagemagick_files.py` like so:
+
+   `python3 imagemagick_files.py`
+
+   If all goes well, the command will finish with no errors and you will see a new file called `a.gif` in your home directory.
+
+

zambeze/orchestration/network.py

@@ -1,4 +1,4 @@
-# Standard imports
+"""Standard imports"""
 import http.client as httplib
 import re
 import socket

zambeze/orchestration/plugins.py

@@ -6,15 +6,12 @@
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the MIT License.
 
-# Required to occur first
 from __future__ import annotations
 
-# Local imports
 from .message.abstract_message import AbstractMessage
 from .plugin_modules.abstract_plugin import Plugin
 from .plugin_modules.common_plugin_functions import registerPlugins
 
-# Standard imports
 from copy import deepcopy
 from dataclasses import asdict
 from importlib import import_module

zambeze/orchestration/plugins_message_template_engine.py

@@ -1,10 +1,8 @@
-# Zambeze internal imports
 from .plugin_modules.common_plugin_functions import registerPlugins
 from .plugin_modules.abstract_plugin_template_generator import (
     PluginMessageTemplateGenerator,
 )
 
-# Standard imports
 from importlib import import_module
 from inspect import isclass
 from typing import Optional

zambeze/orchestration/plugins_message_validator.py

@@ -1,8 +1,6 @@
-# Zambeze internal imports
 from .plugin_modules.common_plugin_functions import registerPlugins
 from .plugin_modules.abstract_plugin_message_validator import PluginMessageValidator
 
-# Standard imports
 from importlib import import_module
 from inspect import isclass
 from typing import Optional