1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

Utility Index

From cloudflu

(Difference between revisions)
Jump to: navigation, search
Line 12: Line 12:
Some of the command-line options are ''persistent'', which means that it is possible to preset it globally from the corresponding ''preferences'' file. Such option will be highlighted by underlying. For example, the following common option are persistent one: '''--<u>debug</u>''', '''--<u>log-file</u>''', '''--<u>aws-access-key-id</u>''' and '''--<u>aws-secret-access-key</u>'''.
Some of the command-line options are ''persistent'', which means that it is possible to preset it globally from the corresponding ''preferences'' file. Such option will be highlighted by underlying. For example, the following common option are persistent one: '''--<u>debug</u>''', '''--<u>log-file</u>''', '''--<u>aws-access-key-id</u>''' and '''--<u>aws-secret-access-key</u>'''.
-
 
-
Below, all the ''CloudFlu'' utilities in alphabetical order are discussed.
 
{| border="0" cellspacing="0" cellpadding="5" width="100%"
{| border="0" cellspacing="0" cellpadding="5" width="100%"
 +
|+ ''CloudFlu'' utilities in alphabetical order
| align="left" | [[cloudflu-clean]]
| align="left" | [[cloudflu-clean]]
| align="left" | [[cloudflu-cluster-ls]]
| align="left" | [[cloudflu-cluster-ls]]
Line 23: Line 22:
| align="left" | [[cloudflu-credentials-deploy]]
| align="left" | [[cloudflu-credentials-deploy]]
| align="left" | [[cloudflu-deploy]]
| align="left" | [[cloudflu-deploy]]
-
|-
 
| align="left" | [[cloudflu-download]]
| align="left" | [[cloudflu-download]]
 +
|-
| align="left" | [[cloudflu-files-clean]]
| align="left" | [[cloudflu-files-clean]]
| align="left" | [[cloudflu-foam2vtk]]
| align="left" | [[cloudflu-foam2vtk]]
Line 30: Line 29:
| align="left" | [[cloudflu-foam2vtk-before]]
| align="left" | [[cloudflu-foam2vtk-before]]
|}
|}
-
 
-
== cloudflu-credentials-deploy ==
 
-
Deploys the Amazon security credentials to the cluster to be able to perform corresponding ''CloudFlu'' functionality on the ''cluster'' side. Usually appears in the context of ''cloudflu-reservation-run'' and ''cloudflu-instance-extract'' utilities. For internal use only.
 
-
 
-
'''Extra options :'''
 
-
* ''--<u>aws-user-id</u>''=< ''AWS User ID'' >
 
-
*: Uses preferences or ${AWS_USER_ID} environment variable, if not specified
 
-
* ''--<u>ec2-private-key</u>''=< ''EC2 Private Key'' >
 
-
*: Uses preferences or ${EC2_PRIVATE_KEY} environment variable, if not specified
 
-
* ''--<u>ec2-cert</u>=< ''EC2 Certificate'' >
 
-
*: Uses preferences or ${EC2_CERT} environment variable, if not specified
 
-
* ''--<u>remote-location</u>=< ''destination of the credendtials environemnt files'' >
 
-
 
-
'''Usage example :''' ''cloudflu-reservation-run | cloudflu-instance-extract | cloudflu-credentials-deploy''
 
-
 
-
== cloudflu-deploy ==
 
-
Deploys the ''CloudFlu'' itself into the ''cluster''. This operation is performed each time for ''cluster'' acquisition to be able automatically use the latest possible version of ''CloudFlu'' functionality. Usually appears in the context of ''cloudflu-reservation-run'' and ''cloudflu-instance-extract'' utilities. For internal use only.
 
-
 
-
'''Extra options :'''
 
-
* ''--<u>production</u>''
 
-
*: If enabled then it deploys the latest official ''CloudFlu'' version
 
-
* ''--<u>url</u>=< ''package name or precise location to download from'' >
 
-
*: 'cloudflu', by default
 
-
 
-
'''Usage example :''' ''cloudflu-reservation-run | cloudflu-instance-extract | cloudflu-deploy''
 
-
 
-
== cloudflu-download ==
 
-
Downloads specified ''study'' data from ''cloud''. This is one of the basic data exchange utility. Usually appears in context of ''cloudflu-upload-start'' and ''cloudflu-upload-resume'' utilities.
 
-
 
-
'''Extra options :'''
 
-
* ''--study-name''=< ''existing study name'' >
 
-
*: Read from standard input, if not specified
 
-
* ''--located-files''=< ''the list of file paths inside the study'' >
 
-
*: User can choose whether to download all data registered for the ''study'' or only appointed onces. This option is extremely useful to load the data into a predefined order (''CloudFlu'' works asynchronously because of multi-threading usage)
 
-
* ''--output-dir''=< ''location of the output data'' >
 
-
*: The same a 'study' name, if not specified
 
-
* ''--<u>fresh</u>'' - replaces the download items even if they already exists if enabled (False, by default)
 
-
* ''--<u>wait</u>'' - waits for the downloading items uploading completion if enabled (False, by default)
 
-
* ''--<u>remove</u>'' - automatically removes from the study downloaded items if enabled (False, by default)
 
-
 
-
'''Usage example :''' ''cloudflu-download --study-name=< user study name >[ --located-files="<file path 1>|<file path 2>.."] --output-dir="./tmp"''
 
-
 
-
== cloudflu-files-clean ==
 
-
Cleans all the file related information from ''cloud''. It works like shutdown for the ''cloud'' data storage functionality. Use this functionality with precautions.
 
-
 
-
Has no additional options.
 
-
 
-
'''Usage example :''' ''cloudflu-files-clean''
 
== cloudflu-foam2vtk ==
== cloudflu-foam2vtk ==

Revision as of 12:06, 31 December 2010

All the presented utilities have the following common set of options, namely :

  • --version show program's version number and exit.
    All the utilities have the same version number - library version. So, the easiest way to get known what is the version of the CloudFlu you are working with is to run a whatever CloudFlu utility with --version command-line option.
  • -h, --help show this help message and exit.
    Use this option to explore available command-line options, their default values and see corresponding usage example.
  • --debug turn on the debug information displaying.
  • --log-file=< file to write debug information >
  • --aws-access-key-id=< Amazon Key Id >
    Used for communication with Amazon Web Services. Check your Amazon account to obtain corresponding value.
  • --aws-secret-access-key=< Amazon Secret Key >
    Used for communication with Amazon Web Services. Check your Amazon account to obtain corresponding value.

Some of the command-line options are persistent, which means that it is possible to preset it globally from the corresponding preferences file. Such option will be highlighted by underlying. For example, the following common option are persistent one: --debug, --log-file, --aws-access-key-id and --aws-secret-access-key.

CloudFlu utilities in alphabetical order
cloudflu-clean cloudflu-cluster-ls cloudflu-cluster-rm cloudflu-cluster-start cloudflu-config cloudflu-credentials-deploy cloudflu-deploy cloudflu-download
cloudflu-files-clean cloudflu-foam2vtk cloudflu-foam2vtk-after cloudflu-foam2vtk-before

cloudflu-foam2vtk

An example of --time-hook implementation for cloudflu-solver-process utility. It runs the native OpenFOAM foamToVTK utility for the given time-stamp. Cloudflu-solver-process utility, in its turn is responsible for invoking this hook script per each loaded time-stamp. Use this script if you would like automatically perform a post-processing on the calculating solver case.

Usage example : cloudflu-solver-process --study-name=${a_study_name} --output-dir="~/damBreak.out" --time-hook="cloudflu-foam2vtk"

cloudflu-foam2vtk-after

An example of --after-hook implementation for cloudflu-solver-process utility. It launches ParaView application for the given set of "vtk.*" files generated by cloudflu-foam2vtk utility.

Usage example : cloudflu-solver-process --study-name=${a_study_name} --output-dir="~/damBreak.out" --time-hook="cloudflu-foam2vtk" --after-hook="cloudflu-foam2vtk-after"

cloudflu-foam2vtk-before

An example of --before-hook implementation for cloudflu-solver-process utility. It runs native OpenFOAM (R) paraFoam utility for the given output solver case downloaded cloudflu-solver-process utility.

Usage example : cloudflu-solver-process --study-name=${a_study_name} --output-dir="~/damBreak.out" --before-hook="cloudflu-foam2vtk-before" --time-hook="cloudflu-foam2vtk"


Download Installation Guide Documentation Forum Your Ideas GuestBook Bug Tracker Feature Request Project Start Page
Personal tools