Mercurial > public > scc_access / annotate
README.rst@ce6eefd1f4b1 (annotated)
README.rst
Fri, 11 Jan 2019 18:05:26 +0200
- author
- Iannis B <ioannis@inoe.ro>
- date
- Fri, 11 Jan 2019 18:05:26 +0200
- changeset 33
- ce6eefd1f4b1
- parent 30
- 4669876326d4
- child 36
- b51ba2647b41
- permissions
- -rw-r--r--
Small update in readme.
| 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 | -------- |
| moritz@29 | 35 | You will need to change some user-defined settings in a settings.yaml file. You |
| moritz@29 | 36 | can copy the settings_sample.yaml file to settings.py and follow the instructions |
| moritz@29 | 37 | there. You can copy the resulting file to your home directory as `.scc_access.yaml`. |
| moritz@29 | 38 | This is the default location, `scc_access` will search there if no other location was |
| moritz@29 | 39 | specified. |
| ioannis@0 | 40 | |
| ioannis@0 | 41 | Specifically, you will need to: |
| ioannis@0 | 42 | |
| moritz@29 | 43 | 1. Change the `basic_credentials` and `website_credentials` to your credentials. |
| moritz@29 | 44 | 2. Change the `output_dir` to the location were the results will be stored. |
| ioannis@0 | 45 | |
| i@15 | 46 | Please not that it's not a good idea to store your stations management credentials in the settings |
| ioannis@0 | 47 | file. The standard user has "Station Management" privileges and if the credentials |
| ioannis@0 | 48 | are stolen, someone could change/delete the stations settings from the SCC database. |
| ioannis@0 | 49 | For this, it is better to use a used account with minimum access settings, that |
| ioannis@0 | 50 | can only upload files and measurements. |
| ioannis@0 | 51 | |
| ioannis@0 | 52 | |
| ioannis@0 | 53 | Usage |
| ioannis@0 | 54 | ----- |
| ioannis@0 | 55 | |
| ioannis@0 | 56 | You can upload a file specifying the username and the system id:: |
| victor@8 | 57 | |
| moritz@29 | 58 | scc_access upload-file 20110101po01.nc 125 |
| ioannis@0 | 59 | |
| ioannis@0 | 60 | If you want to wait for the processing to finish and download the resulting files |
| ioannis@33 | 61 | you need to define the `process-file` command :: |
| victor@8 | 62 | |
| ioannis@33 | 63 | scc_access process-file 20110101po01.nc 125 |
| ioannis@0 | 64 | |
| moritz@29 | 65 | If you want to delete an existing measurement id from the database use the `delete` |
| moritz@29 | 66 | command and the measurement id:: |
| victor@8 | 67 | |
| moritz@29 | 68 | scc_access delete 20110101po01 |
| moritz@29 | 69 | |
| moritz@29 | 70 | You can list available measurements with the `list` command:: |
| moritz@29 | 71 | |
| moritz@29 | 72 | scc_access list |
| ioannis@0 | 73 | |
| ioannis@0 | 74 | For more information on the syntax type:: |
| victor@8 | 75 | |
| victor@9 | 76 | scc_access -h |
