victor@7: Overview
i@15: ========
ioannis@0: 
i@15: This package provides a tool for interacting with the
victor@7: Single Calculus Chain through the command line. Specifically, with the script you can:
ioannis@0: 
ioannis@0: * Upload a file to the SCC for processing
ioannis@0: * Download the processed files and graphs
ioannis@0: * Delete an existing measurement from the SCC (with appropriate privileges)
ioannis@0: 
ioannis@0: The main functions are implemented in a class (SCC) that you can also import 
ioannis@0: and use in your custom scripts.
ioannis@0: 
ioannis@0: The script does not provide any feedback if a file upload fails. Before using
ioannis@0: the script, you will need to upload some files manually and be confident that 
ioannis@0: your SCC file format and processing settings are correct.
ioannis@0: 
i@12: Please note that this is not part of the "official" SCC tools.
ioannis@0: 
ioannis@0: Any suggestions for improvements and new features are more than welcome.
ioannis@0: 
ioannis@1: 
ioannis@0: Installation
ioannis@0: ------------
ioannis@0: 
victor@9: The easiest way to install this module is from the python package index using pip::
victor@8:     
ioannis@42:     pip install hg+https://repositories.imaa.cnr.it/public/scc_access/#egg=scc-access
ioannis@0: 
i@15: You can also use the script by cloning this mercurial repository.
ioannis@1: 
ioannis@0: 
ioannis@0: Settings
ioannis@0: --------
i@15: You will need to provide some user-defined settings in a .yaml format. You
ioannis@42: can rename the config_sample.yaml file to e.g. config.yaml and follow the instructions
ioannis@42: inside the file.
ioannis@0: 
ioannis@0: Specifically, you will need to:
ioannis@0: 
ioannis@0: 1. Change the BASIC_LOGIN and DJANGO_LOGIN to your credentials.
ioannis@0: 2. Change the OUTPUT_DIR to the location were the results will be stored.
ioannis@0: 
i@15: Please not that it's not a good idea to store your stations management credentials in the settings
ioannis@0: file. The standard user has "Station Management" privileges and if the credentials 
ioannis@0: are stolen, someone could change/delete the stations settings from the SCC database.
ioannis@42: For this, it is better to use a user account with minimum access settings, i.e. that
ioannis@0: can only upload files and measurements.
ioannis@0: 
ioannis@0: 
ioannis@0: Usage
ioannis@0: -----
ioannis@0: 
ioannis@0: You can upload a file specifying the username and the system id::
victor@8:     
ioannis@42:    scc_access ./config.yaml ./20110101po01.nc 125
ioannis@0: 
ioannis@0: If you want to wait for the processing to finish and download the resulting files
ioannis@0: you need to define the -p flag::
victor@8:     
ioannis@42:    scc_access ./config.yaml ./20110101po01.nc 125 -p
ioannis@42: 
ioannis@42: If the provieded measurement ID is already registerd on the SCC, the upload will be rejected. You can
ioannis@42: instruct the script to first delete the existing measurement using the --force_upload flag::
ioannis@42: 
ioannis@42:    scc_access ./config.yaml ./20110101po01.nc 125 --force_upload -p
ioannis@0: 
ioannis@42: You can restart the processing chain on a particular measurements using either the --rerun-all or
ioannis@42: --rerun-elpp options and specifying an existing measurement ID. E.g::
ioannis@42: 
ioannis@42:    scc_access ./config.yaml --rerun-elpp 20110101po02
ioannis@42: 
ioannis@42: If you want to delete an existing measurement from the database use the --delete option and
ioannis@0: the measurement id::
victor@8:     
ioannis@42:     scc_access --delete 20110101po01
ioannis@0: 
ioannis@0: For more information on the syntax type::
victor@8:     
victor@9:     scc_access -h