README.rst

Wed, 10 Jan 2018 18:06:02 +0200

author
Iannis <i.binietoglou@impworks.gr>
date
Wed, 10 Jan 2018 18:06:02 +0200
changeset 16
ddaea4327bd5
parent 15
93b6b945d939
child 30
4669876326d4
child 42
c95ee9720e7b
permissions
-rw-r--r--

Changes config to positional argument.

victor@7 1 Overview
i@15 2 ========
ioannis@0 3
i@15 4 This package provides a tool for interacting with the
victor@7 5 Single Calculus Chain through the command line. Specifically, with the script you can:
ioannis@0 6
ioannis@0 7 * Upload a file to the SCC for processing
ioannis@0 8 * Download the processed files and graphs
ioannis@0 9 * Delete an existing measurement from the SCC (with appropriate privileges)
ioannis@0 10
ioannis@0 11 The main functions are implemented in a class (SCC) that you can also import
ioannis@0 12 and use in your custom scripts.
ioannis@0 13
ioannis@0 14 The script does not provide any feedback if a file upload fails. Before using
ioannis@0 15 the script, you will need to upload some files manually and be confident that
ioannis@0 16 your SCC file format and processing settings are correct.
ioannis@0 17
i@12 18 Please note that this is not part of the "official" SCC tools.
ioannis@0 19
ioannis@0 20 Any suggestions for improvements and new features are more than welcome.
ioannis@0 21
ioannis@1 22
ioannis@0 23 Installation
ioannis@0 24 ------------
ioannis@0 25
victor@9 26 The easiest way to install this module is from the python package index using pip::
victor@8 27
i@15 28 pip install hg+https://bitbucket.org/iannis_b/scc-access#egg=scc-access
ioannis@0 29
i@15 30 You can also use the script by cloning this mercurial repository.
ioannis@1 31
ioannis@0 32
ioannis@0 33 Settings
ioannis@0 34 --------
i@15 35 You will need to provide some user-defined settings in a .yaml format. You
i@15 36 can rename the settings_sample.yaml file to settings.yaml and follow the instructions
ioannis@0 37 there.
ioannis@0 38
ioannis@0 39 Specifically, you will need to:
ioannis@0 40
ioannis@0 41 1. Change the BASIC_LOGIN and DJANGO_LOGIN to your credentials.
ioannis@0 42 2. Change the OUTPUT_DIR to the location were the results will be stored.
ioannis@0 43
i@15 44 Please not that it's not a good idea to store your stations management credentials in the settings
ioannis@0 45 file. The standard user has "Station Management" privileges and if the credentials
ioannis@0 46 are stolen, someone could change/delete the stations settings from the SCC database.
ioannis@0 47 For this, it is better to use a used account with minimum access settings, that
ioannis@0 48 can only upload files and measurements.
ioannis@0 49
ioannis@0 50
ioannis@0 51 Usage
ioannis@0 52 -----
ioannis@0 53
ioannis@0 54 You can upload a file specifying the username and the system id::
victor@8 55
victor@8 56 scc_access 20110101po01.nc 125
ioannis@0 57
ioannis@0 58 If you want to wait for the processing to finish and download the resulting files
ioannis@0 59 you need to define the -p flag::
victor@8 60
victor@9 61 scc_access 20110101po01.nc 125 -p
ioannis@0 62
ioannis@0 63 If you want to delete an existing measurement id from the database use the -d flag and
ioannis@0 64 the measurement id::
victor@8 65
victor@9 66 scc_access -d 20110101po01
ioannis@0 67
ioannis@0 68 For more information on the syntax type::
victor@8 69
victor@9 70 scc_access -h

mercurial