Skip to content

Commit 3d54321

Browse files
committed
Document rules for file naming and directory structure
This PR documents the important discussions in #37, #48, #53. Closes #37. Closes #48. Closes #53. Closes #63.
1 parent 6f9c316 commit 3d54321

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

MAINTENANCE.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Maintainers Guide
2+
3+
This page contains information about the GMT data server.
4+
5+
## Naming of the remote files
6+
7+
The remote files have names following the pattern:
8+
9+
planet_name_rru_reg.suffix
10+
11+
in which:
12+
13+
- *planet* can be *earth*, *moon*, *mars* et al.
14+
- *name* is the name of the dataset, like *relief*, *mask*
15+
- *rru* is the grid resolution. *u* is the unit, and can be **d** (degree), **m** (minute) or **s** (second)
16+
- *reg* is the grid registration. It can be either **p** (pixel) or **g** (gridline)
17+
- *suffix* is the grid suffix. It can be *grd* or *tif*.
18+
19+
## Grid registrations
20+
21+
GMT serves up both pixel and gridline registered files if possible.
22+
23+
If users don't specify a registration, the default registration will be returned.
24+
25+
- GMT<=6.0 returns the gridline-registered version for backward compatibility.
26+
- GMT>=6.1 returns the pixel-registered version unless only the gridline-registered
27+
file is available.
28+
29+
## Organization of directories
30+
31+
The layout of the directories and files on the data server look like:
32+
33+
```
34+
cache: [Odds and ends used for tests and examples tutorial etc.]
35+
geography: [The coastline data]
36+
dcw
37+
gshhg
38+
server: [Data served by us]
39+
earth
40+
earth_age
41+
earth_day
42+
earth_night
43+
earth_mask
44+
earth_relief
45+
...
46+
moon
47+
...
48+
mars
49+
...
50+
```

0 commit comments

Comments
 (0)