README.rst 1.05 KB
Newer Older
1
2
csppfetch
=========
Alan De Smet's avatar
Alan De Smet committed
3

Alan De Smet's avatar
Alan De Smet committed
4
csppfetch is a Python 3 module for downloading dynamic ancillary data. It can:
Alan De Smet's avatar
Alan De Smet committed
5

Alan De Smet's avatar
Alan De Smet committed
6
- Maintain a local cache of ancillary data 
7

Alan De Smet's avatar
Alan De Smet committed
8
- Download the specific ancillary data files needed to process a given time step
9
10
11

  - Using the local cache if available
  - Optionally updating the local cache
Alan De Smet's avatar
Alan De Smet committed
12

Alan De Smet's avatar
Alan De Smet committed
13
14
15
Final files in the cache are atomically created; from the perspective of other
programs a given ancillary data file either completely exists or doesn't exist
at all.
Alan De Smet's avatar
Alan De Smet committed
16

Alan De Smet's avatar
Alan De Smet committed
17
18
19
Multiple copies of this module can safely run at the same time; locks are used
to ensure they don't interfere with each other. (Your operating system and
filesystem will need to correctly implement ``lockf``.)
Alan De Smet's avatar
Alan De Smet committed
20

Alan De Smet's avatar
Alan De Smet committed
21
22
23
If a file is already present in the local cache, this module will NOT replace
them; their existence is assumed to mean they are correct. To force a
re-download, delete the existing file.
Alan De Smet's avatar
Alan De Smet committed
24

Alan De Smet's avatar
Alan De Smet committed
25
csppfetch implements the 
Alan De Smet's avatar
Alan De Smet committed
26
`CSPP Geo ancillary download behavior guidelines <https://docs.google.com/document/d/1phQRbELddAl4AG2EdAvzlJOKdYD0HRu-TpD3fj7J1rA/edit?pli=1>`_.
Alan De Smet's avatar
Alan De Smet committed
27

Alan De Smet's avatar
Alan De Smet committed
28
Requires Python 3.6 or later.