Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
iiman committed May 9, 2016
1 parent 81ceb5d commit e3fe355
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 15 deletions.
18 changes: 7 additions & 11 deletions docs/chimineyui.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,23 @@
Chiminey User Interface
~~~~~~~~~~~~~~~~~~~~~~~

The Chiminey server automatically generates a job submission web page for each smart connector.
The Chiminey platform automatically generates a job submission web page for each smart connector.
However, this web page contains only a drop down menu of :ref:`presets <manage_presets>`. The web page
will also
contain a `parameter sweep <https://github.com/chiminey/chiminey/wiki/Types-of-Input-Form-Fields#sweep>`__
contain a :ref:`parameter sweep <parametersweep>`
input field for smart connectors with a sweep feature.
Since these two input fields are not sufficient to submit a job,
the developer should specify the input fields that are needed to submit
a particular smart connector job.
This is done during the :ref:`definition of the smart connector <constrtuct_smart_conn_ui>`.


There are various `input field types <https://github.com/chiminey/chiminey/wiki/Types-of-Input-Form-Fields>`_ like
computation platform, location and domain-specific variables.
Some of the fields are already included within the Chiminey platform. But others, especially the domain-specific
ones, will be defined by the developer.
The following table shows the list of input field types and their corresponding schema namespaces included within the Chiminey platform.
Within the Chiminey platform, there are various :ref:`input field types <chiminey_ui>`, organised in groups like
compute resource varibales, location variables and domain-specific variables.
The input fields, except the domain-specific ones, are provided via ``INPUT_FIELDS`` parameter in ``chiminey/settings_changeme.py``.
The following table shows the list of input field types and their description.


**NB**: The default value of ``SCHEMA_PREFIX`` is ``"http://rmit.edu.au/schemas"``


+-----------------------------------------------------+------------------------------------------------+
Expand Down Expand Up @@ -217,6 +216,3 @@ Below is an example of a new input field type definition: which contains a natur


1. :ref:`Quick Example: The Random Number Smart Connector for Non-Cloud Execution <quick_example>`



4 changes: 1 addition & 3 deletions docs/platformsettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ Resource Management
A Chiminey platform supports access to computation and
storage resources. A computation resource is where the core functionality of a
smart connector is executed while a storage resource is used to retrieve input files and store output files.
Prior to submitting a job, end-users need
to register at least one computation and one storage resources. In this
section, following topics are covered:
Prior to submitting a job, end-users need to register at least one computation and one storage resources. In this section, following topics are covered:

- :ref:`register_computation_resource`
- :ref:`register_storage_resource`
Expand Down
2 changes: 1 addition & 1 deletion docs/smartconnector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Creating a smart connector involves completing three tasks:
#. :ref:`registering <sc_registration>` the new smart connector with the Chiminey platform.


Each tasks are discussed below by creating an example smart connector. This smart connector generates a random number with a timestamp, and then writes the output to a file.
Each of the three tasks is discussed below by creating an example smart connector. This smart connector generates a random number with a timestamp, and then writes the output to a file.


**NB**: Login to the Chiminey docker container.
Expand Down

0 comments on commit e3fe355

Please sign in to comment.