Project

General

Profile

Download (3.27 KB) Statistics
| Branch: | Revision:
1
==========================================
2
 Environmental Layers repository overview
3
==========================================
4

    
5
At the top-level, the repository is split into four main topical domains
6
(``climate``, ``derived-climate``, ``land-cover``, and ``terrain``),
7
plus an additional ``shared`` directory for general project-level
8
materials. Each of the topical directories themselves contain up to 6
9
predetermined subdirectories as indicated below. See descriptions for
10
specific criteria for determining what goes in each directory.
11

    
12
**All committed work should fall within this directory structure.**
13

    
14
``research``
15
  Scripts, notes, generated summaries/reports, and possibly additional
16
  relevant background information intended to inform and/or evaluate
17
  methodological decisions. The defining criterion is that these
18
  materials are *not* designed to be used as operational components of
19
  the eventual data production workflow itself, but instead serve to
20
  guide its development. Examples include case studies, statistical
21
  model comparisons, dataset assessments, validation procedures, etc. 
22

    
23
``procedures``
24
  Scripts that either have been, could be, or will be executed with the
25
  express purpose of *producing data*, including acquisition of data
26
  from elsewhere, creation of intermediate datasets, and production of
27
  final layers. Prose (or mixed prose/text) text documents may be
28
  substituted for executable scripts if absolutely necessary, e.g. to
29
  express procedures that had to be performed manually.
30

    
31
``tests``
32
  Scripts intended for testing whether particular data holdings meet
33
  expectations (e.g., completeness, consistency, etc), or for testing
34
  whether particular scripts produce output as expected given specified
35
  test inputs. Although not necessarily the case while in-development,
36
  ultimately all tests should be able to run without intervention,
37
  reporting either success or failure along with appropriate supporting
38
  details.
39

    
40
``doc``
41
  Documentation and associated files (figures, thumbnail images, etc).
42
  Strong preference should be given to text-based documentation
43
  (including standard markup formats), and especially reproducible
44
  documentation schemes such as LaTeX/Sweave.
45

    
46
``lib``
47
  Source code (possibly with supporting materials such as Makefiles)
48
  that contains generally useful and reusable bits of functionality that
49
  are or could be leveraged elsewhere. The idea is that these would be
50
  imported, included, sourced, etc. by scripts in one or more other
51
  project directories.
52

    
53
``extra``
54
  Miscellaneous notes, code snippets, blue-sky scripts, and other
55
  materials that seem worth capturing into this repository, but don't
56
  fit under any other directories.
57

    
58

    
59
*Directory tree:*
60
::
61

    
62
 .
63
 ├── climate/
64
 │   ├── research/
65
 │   ├── procedures/
66
 │   ├── tests/
67
 │   ├── lib/
68
 │   ├── doc/
69
 │   └── extra/
70
 ├── derived-climate/
71
 │   ├──
72
 │   ├──
73
 │   ├── <as above>
74
 │   ├──
75
 │   ├──
76
 │   └──
77
 ├── land-cover/
78
 │   ├──
79
 │   ├──
80
 │   ├── <as above>
81
 │   ├──
82
 │   ├──
83
 │   └──
84
 ├── terrain/
85
 │   ├──
86
 │   ├──
87
 │   ├── <as above>
88
 │   ├──
89
 │   ├──
90
 │   └──
91
 └── shared/ 
92

    
(2-2/2)