Mercurial > public > scc_access / annotate
README.rst@06abef993230 (annotated)
README.rst
Tue, 12 Dec 2017 09:29:34 +0200
- author
- Victor Nicolae <victor.nicolae@inoe.ro>
- date
- Tue, 12 Dec 2017 09:29:34 +0200
- changeset 9
- 06abef993230
- parent 8
- cf12f8c7838e
- child 12
- 9cc8d8d69af7
- permissions
- -rw-r--r--
Revise documentation formatting.
| victor@7 | 1 | Overview |
| ioannis@0 | 2 | ================= |
| ioannis@0 | 3 | |
| victor@7 | 4 | This package provides a script which permits 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 | |
| ioannis@0 | 18 | Please note that this is not part of the "official" SCC tools. I will update |
| ioannis@0 | 19 | it when I have time but I cannot guarantee to maintain it in the long run. |
| ioannis@0 | 20 | |
| ioannis@0 | 21 | Any suggestions for improvements and new features are more than welcome. |
| ioannis@0 | 22 | |
| ioannis@1 | 23 | |
| ioannis@0 | 24 | Installation |
| ioannis@0 | 25 | ------------ |
| ioannis@0 | 26 | |
| victor@9 | 27 | The easiest way to install this module is from the python package index using pip:: |
| victor@8 | 28 | |
| victor@8 | 29 | pip install scc_access |
| ioannis@0 | 30 | |
| ioannis@0 | 31 | See http://docs.python-requests.org/en/latest/user/install/ for more details. |
| ioannis@0 | 32 | |
| victor@7 | 33 | You can also use the script by cloning this mercurial repository. Alternatively, you |
| victor@7 | 34 | can just copy the scc_access.py and and settings.sample.py files to a local |
| ioannis@1 | 35 | directory. |
| ioannis@1 | 36 | |
| ioannis@0 | 37 | |
| ioannis@0 | 38 | Settings |
| ioannis@0 | 39 | -------- |
| ioannis@0 | 40 | You will need to change some user-defined settings in a settings.py file. You |
| ioannis@0 | 41 | can rename the settings.sample.py file to settings.py and follow the instructions |
| ioannis@0 | 42 | there. |
| ioannis@0 | 43 | |
| ioannis@0 | 44 | Specifically, you will need to: |
| ioannis@0 | 45 | |
| ioannis@0 | 46 | 1. Change the BASIC_LOGIN and DJANGO_LOGIN to your credentials. |
| ioannis@0 | 47 | 2. Change the OUTPUT_DIR to the location were the results will be stored. |
| ioannis@0 | 48 | |
| ioannis@0 | 49 | Please not that it's not a good idea to store your own credentials in the settings |
| ioannis@0 | 50 | file. The standard user has "Station Management" privileges and if the credentials |
| ioannis@0 | 51 | are stolen, someone could change/delete the stations settings from the SCC database. |
| ioannis@0 | 52 | For this, it is better to use a used account with minimum access settings, that |
| ioannis@0 | 53 | can only upload files and measurements. |
| ioannis@0 | 54 | |
| ioannis@0 | 55 | |
| ioannis@0 | 56 | Usage |
| ioannis@0 | 57 | ----- |
| ioannis@0 | 58 | |
| ioannis@0 | 59 | You can upload a file specifying the username and the system id:: |
| victor@8 | 60 | |
| victor@8 | 61 | scc_access 20110101po01.nc 125 |
| ioannis@0 | 62 | |
| ioannis@0 | 63 | If you want to wait for the processing to finish and download the resulting files |
| ioannis@0 | 64 | you need to define the -p flag:: |
| victor@8 | 65 | |
| victor@9 | 66 | scc_access 20110101po01.nc 125 -p |
| ioannis@0 | 67 | |
| ioannis@0 | 68 | If you want to delete an existing measurement id from the database use the -d flag and |
| ioannis@0 | 69 | the measurement id:: |
| victor@8 | 70 | |
| victor@9 | 71 | scc_access -d 20110101po01 |
| ioannis@0 | 72 | |
| ioannis@0 | 73 | For more information on the syntax type:: |
| victor@8 | 74 | |
| victor@9 | 75 | scc_access -h |
