victor@7: Overview
ioannis@0: =================
ioannis@0: 
victor@7: This package provides a script which permits 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:     
victor@8:     pip install scc_access
ioannis@0: 
ioannis@0: See http://docs.python-requests.org/en/latest/user/install/ for more details.
ioannis@0: 
victor@7: You can also use the script by cloning this mercurial repository. Alternatively, you 
victor@7: can just copy the scc_access.py and and settings.sample.py files to a local 
ioannis@1: directory.
ioannis@1: 
ioannis@0: 
ioannis@0: Settings
ioannis@0: --------
moritz@29: You will need to change some user-defined settings in a settings.yaml file. You
moritz@29: can copy the settings_sample.yaml file to settings.py and follow the instructions
moritz@29: there. You can copy the resulting file to your home directory as `.scc_access.yaml`.
moritz@29: This is the default location, `scc_access` will search there if no other location was
moritz@29: specified.
ioannis@0: 
ioannis@0: Specifically, you will need to:
ioannis@0: 
moritz@29: 1. Change the `basic_credentials` and `website_credentials` to your credentials.
moritz@29: 2. Change the `output_dir` to the location were the results will be stored.
ioannis@0: 
ioannis@0: Please not that it's not a good idea to store your own 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@0: For this, it is better to use a used account with minimum access settings, 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:     
moritz@29:     scc_access upload-file 20110101po01.nc 125
ioannis@0: 
ioannis@0: If you want to wait for the processing to finish and download the resulting files
moritz@29: you need to define the `process-file` command. Use the `-p` flag to wait for the
moritz@29: result::
victor@8:     
moritz@29:     scc_access process-file 20110101po01.nc 125 -p
ioannis@0: 
moritz@29: If you want to delete an existing measurement id from the database use the `delete`
moritz@29: command and the measurement id::
victor@8:     
moritz@29:     scc_access delete 20110101po01
moritz@29: 
moritz@29: You can list available measurements with the `list` command::
moritz@29: 
moritz@29:     scc_access list
ioannis@0: 
ioannis@0: For more information on the syntax type::
victor@8:     
victor@9:     scc_access -h