national_grid 0.1.1 → 0.1.2

data/ext/ostn02c/OSTN02/testCoords.data

@@ -0,0 +1,160 @@
+static const LatLonDegMinSec testETRSCoords[] = {
+  
+  // OSTN02 test coordinates provided by OS
+  
+  {.lat = {.deg = 53, .min = 46, .sec = L(44.796925), .westOrSouth = false}, 
+   .lon = {.deg =  3, .min =  2, .sec = L(25.637665), .westOrSouth = true }, .elevation =  L(64.940)},
+  {.lat = {.deg = 51, .min = 25, .sec = L(39.170761), .westOrSouth = false}, 
+   .lon = {.deg =  2, .min = 32, .sec = L(38.674270), .westOrSouth = true }, .elevation = L(104.018)},
+  {.lat = {.deg = 58, .min = 30, .sec = L(56.173025), .westOrSouth = false}, 
+   .lon = {.deg =  6, .min = 15, .sec = L(39.292403), .westOrSouth = true }, .elevation = L(115.026)},
+  {.lat = {.deg = 54, .min = 53, .sec = L(43.524259), .westOrSouth = false},
+   .lon = {.deg =  2, .min = 56, .sec = L(17.798693), .westOrSouth = true }, .elevation =  L(93.541)},
+  {.lat = {.deg = 51, .min = 51, .sec = L(32.072283), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 18, .sec = L(30.689158), .westOrSouth = true }, .elevation =  L(81.351)},
+  {.lat = {.deg = 51, .min = 53, .sec = L(39.718951), .westOrSouth = false}, 
+   .lon = {.deg =  0, .min = 53, .sec = L(50.075790), .westOrSouth = false}, .elevation =  L(75.273)},
+  {.lat = {.deg = 53, .min = 20, .sec = L(41.290104), .westOrSouth = false}, 
+   .lon = {.deg =  2, .min = 38, .sec = L(25.775546), .westOrSouth = true }, .elevation =  L(88.411)},
+  {.lat = {.deg = 52, .min = 15, .sec = L(19.057739), .westOrSouth = false}, 
+   .lon = {.deg =  2, .min =  9, .sec = L(16.510138), .westOrSouth = true }, .elevation = L(101.526)},
+  {.lat = {.deg = 55, .min = 55, .sec = L(29.217549), .westOrSouth = false}, 
+   .lon = {.deg =  3, .min = 17, .sec = L(41.251876), .westOrSouth = true }, .elevation = L(119.032)},
+  {.lat = {.deg = 54, .min =  7, .sec =  L(0.665196), .westOrSouth = false}, 
+   .lon = {.deg =  0, .min =  4, .sec = L(39.832776), .westOrSouth = true }, .elevation =  L(86.778)},
+  {.lat = {.deg = 57, .min =  8, .sec = L(20.490695), .westOrSouth = false}, 
+   .lon = {.deg =  2, .min =  2, .sec = L(54.817138), .westOrSouth = true }, .elevation = L(108.610)},
+  {.lat = {.deg = 55, .min = 51, .sec = L(14.398307), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 17, .sec = L(47.364560), .westOrSouth = true }, .elevation =  L(71.617)},
+  {.lat = {.deg = 57, .min = 29, .sec = L(10.500012), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 13, .sec =  L(9.350362), .westOrSouth = true }, .elevation =  L(66.178)},
+  {.lat = {.deg = 54, .min = 19, .sec = L(45.103478), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 23, .sec = L(18.568248), .westOrSouth = true }, .elevation =  L(94.503)},
+  {.lat = {.deg = 54, .min =  5, .sec = L(11.987451), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 38, .sec =  L(4.278066), .westOrSouth = true }, .elevation =  L(84.366)},
+  {.lat = {.deg = 52, .min = 45, .sec =  L(4.920748), .westOrSouth = false}, 
+   .lon = {.deg =  0, .min = 24, .sec =  L(5.527717), .westOrSouth = false}, .elevation =  L(66.431)},
+  {.lat = {.deg = 53, .min = 48, .sec =  L(0.774717), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 39, .sec = L(49.650033), .westOrSouth = true }, .elevation = L(215.609)},
+  {.lat = {.deg = 49, .min = 57, .sec = L(36.220979), .westOrSouth = false}, 
+   .lon = {.deg =  5, .min = 12, .sec = L(10.965961), .westOrSouth = true }, .elevation = L(124.269)},
+  {.lat = {.deg = 51, .min = 29, .sec = L(21.716326), .westOrSouth = false}, 
+   .lon = {.deg =  0, .min =  7, .sec = L(11.732031), .westOrSouth = true }, .elevation =  L(66.057)},
+  {.lat = {.deg = 53, .min = 24, .sec = L(58.626568), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 17, .sec = L(21.050495), .westOrSouth = true }, .elevation = L(100.776)},
+  {.lat = {.deg = 53, .min = 24, .sec = L(58.713306), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 17, .sec = L(21.040535), .westOrSouth = true }, .elevation = L(100.854)},
+  {.lat = {.deg = 57, .min =  0, .sec = L(21.841075), .westOrSouth = false}, 
+   .lon = {.deg =  5, .min = 49, .sec = L(42.120935), .westOrSouth = true }, .elevation =  L(68.494)},
+  {.lat = {.deg = 51, .min = 24, .sec =  L(2.815934), .westOrSouth = false}, 
+   .lon = {.deg =  3, .min = 33, .sec =  L(4.620554), .westOrSouth = true }, .elevation = L(112.371)},
+  {.lat = {.deg = 54, .min = 58, .sec = L(44.841864), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 36, .sec = L(59.676644), .westOrSouth = true }, .elevation = L(125.878)},
+  {.lat = {.deg = 51, .min = 22, .sec = L(28.092933), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 26, .sec = L(40.370305), .westOrSouth = false}, .elevation =  L(99.439)},
+  {.lat = {.deg = 52, .min = 15, .sec =  L(5.794233), .westOrSouth = false}, 
+   .lon = {.deg =  0, .min = 54, .sec = L(44.962452), .westOrSouth = true }, .elevation = L(131.594)},
+  {.lat = {.deg = 52, .min = 57, .sec = L(43.887942), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 11, .sec = L(50.915622), .westOrSouth = true }, .elevation =  L(93.825)},
+  {.lat = {.deg = 50, .min = 55, .sec = L(52.605759), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 27, .sec =  L(1.851626), .westOrSouth = true }, .elevation = L(100.405)},
+  {.lat = {.deg = 50, .min = 26, .sec = L(19.889717), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min =  6, .sec = L(31.124303), .westOrSouth = true }, .elevation = L(215.251)},
+  {.lat = {.deg = 50, .min = 34, .sec = L(32.291946), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 17, .sec = L(52.161977), .westOrSouth = true }, .elevation =  L(94.688)},
+  {.lat = {.deg = 59, .min = 51, .sec = L(14.756913), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 16, .sec = L(29.528804), .westOrSouth = true }, .elevation = L(149.890)},
+  {.lat = {.deg = 58, .min = 34, .sec = L(52.336612), .westOrSouth = false}, 
+   .lon = {.deg =  3, .min = 43, .sec = L(34.716767), .westOrSouth = true }, .elevation =  L(98.634)},
+  {.lat = {.deg = 49, .min = 55, .sec = L(20.150196), .westOrSouth = false}, 
+   .lon = {.deg =  6, .min = 17, .sec = L(59.199098), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 53, .min = 20, .sec = L(49.312599), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 51, .sec =  L(3.503091), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 56, .min = 10, .sec = L(31.115299), .westOrSouth = false}, 
+   .lon = {.deg =  2, .min = 22, .sec = L(31.048596), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 57, .min = 48, .sec = L(48.666318), .westOrSouth = false}, 
+   .lon = {.deg =  8, .min = 34, .sec = L(42.760597), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 58, .min = 12, .sec = L(45.440933), .westOrSouth = false}, 
+   .lon = {.deg =  7, .min = 35, .sec = L(33.200272), .westOrSouth = true }, .elevation = L(140.404)},
+  {.lat = {.deg = 59, .min =  5, .sec = L(48.178240), .westOrSouth = false}, 
+   .lon = {.deg =  5, .min = 49, .sec = L(40.776272), .westOrSouth = true }, .elevation = L(140.716)},
+  {.lat = {.deg = 59, .min =  5, .sec = L(36.061263), .westOrSouth = false}, 
+   .lon = {.deg =  4, .min = 25, .sec =  L(3.276270), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 60, .min =  7, .sec = L(59.091315), .westOrSouth = false}, 
+   .lon = {.deg =  2, .min =  4, .sec = L(25.781605), .westOrSouth = true }, .elevation = L(140.716)},
+  {.lat = {.deg = 59, .min = 32, .sec =  L(4.948596), .westOrSouth = false}, 
+   .lon = {.deg =  1, .min = 37, .sec = L(30.610770), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 59, .min =  2, .sec = L(14.779356), .westOrSouth = false}, 
+   .lon = {.deg =  3, .min = 12, .sec = L(52.344038), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 58, .min = 43, .sec =  L(8.173859), .westOrSouth = false}, 
+   .lon = {.deg =  3, .min =  4, .sec = L(26.133727), .westOrSouth = true }, .elevation = L(100.000)},
+  {.lat = {.deg = 58, .min = 43, .sec = L(15.898312), .westOrSouth = false}, 
+   .lon = {.deg =  3, .min =  8, .sec = L(16.378343), .westOrSouth = true }, .elevation = L(100.000)},
+  
+  // extra (extreme) coords
+  
+  {.lat = {.deg =  90, .min =  0, .sec =  L(0.000000), .westOrSouth = false}, 
+   .lon = {.deg =   0, .min =  0, .sec =  L(0.000000), .westOrSouth = false}, .elevation = L(100.000)},  // N pole
+  {.lat = {.deg =  90, .min =  0, .sec =  L(0.000000), .westOrSouth = true }, 
+   .lon = {.deg =   0, .min =  0, .sec =  L(0.000000), .westOrSouth = false}, .elevation = L(100.000)},  // S pole
+  {.lat = {.deg =  51, .min =  0, .sec =  L(0.000000), .westOrSouth = true }, 
+   .lon = {.deg = 180, .min =  0, .sec =  L(0.000000), .westOrSouth = false}, .elevation = L(100.000)},  // other side of world
+  {.lat = {.deg =   0, .min =  0, .sec =  L(0.000000), .westOrSouth = false}, 
+   .lon = {.deg =   0, .min =  0, .sec =  L(0.000000), .westOrSouth = false}, .elevation = L(100.000)},  // equator/Greenwich Meridian
+};
+
+static const EastingNorthing testOSGB36Coords[] = {
+
+  // these coordinates come either from the OSTN02 test files, or from one of the online OS conversion tools (marked '*')
+  // -- sometimes the elevations differ by 1mm, presumably because of rounding policies
+  
+  {.e = L(331534.552), .n =  L(431920.792), .elevation =  L(12.636), .geoid =  1},
+  {.e = L(362269.979), .n =  L(169978.688), .elevation =  L(54.467), .geoid =  1},
+  {.e = L(151968.641), .n =  L(966483.777), .elevation =  L(58.836), .geoid =  4},
+  {.e = L(339921.133), .n =  L(556034.759), .elevation =  L(41.077), .geoid =  1},
+  {.e = L(241124.573), .n =  L(220332.638), .elevation =  L(27.590), .geoid =  1},
+  {.e = L(599445.578), .n =  L(225722.824), .elevation =  L(30.192), .geoid =  1},
+  {.e = L(357455.831), .n =  L(383290.434), .elevation =  L(36.750), .geoid =  1},
+  {.e = L(389544.178), .n =  L(261912.151), .elevation =  L(51.977), .geoid =  1},
+  {.e = L(319188.423), .n =  L(670947.532), .elevation =  L(66.361), .geoid =  1}, // *
+  {.e = L(525745.658), .n =  L(470703.211), .elevation =  L(41.217), .geoid =  1},
+  {.e = L(397160.479), .n =  L(805349.734), .elevation =  L(58.902), .geoid =  1},
+  {.e = L(256340.914), .n =  L(664697.266), .elevation =  L(17.414), .geoid =  1},
+  {.e = L(267056.756), .n =  L(846176.969), .elevation =  L(13.230), .geoid =  1},
+  {.e = L(244780.625), .n =  L(495254.884), .elevation =  L(39.891), .geoid =  3},
+  {.e = L(227778.318), .n =  L(468847.386), .elevation =  L(29.335), .geoid =  3},
+  {.e = L(562180.535), .n =  L(319784.993), .elevation =  L(20.889), .geoid =  1}, // *
+  {.e = L(422242.174), .n =  L(433818.699), .elevation = L(165.891), .geoid =  1},
+  {.e = L(170370.706), .n =   L(11572.404), .elevation =  L(71.223), .geoid =  1}, // *
+  {.e = L(530624.963), .n =  L(178388.461), .elevation =  L(20.518), .geoid =  1},
+  {.e = L(247958.959), .n =  L(393492.906), .elevation =  L(46.315), .geoid =  1}, // *
+  {.e = L(247959.229), .n =  L(393495.580), .elevation =  L(46.393), .geoid =  1},
+  {.e = L(167634.190), .n =  L(797067.142), .elevation =  L(13.190), .geoid =  1},
+  {.e = L(292184.858), .n =  L(168003.462), .elevation =  L(60.615), .geoid =  1},
+  {.e = L(424639.343), .n =  L(565012.700), .elevation =  L(76.551), .geoid =  1},
+  {.e = L(639821.823), .n =  L(169565.856), .elevation =  L(55.110), .geoid =  1},
+  {.e = L(474335.957), .n =  L(262047.752), .elevation =  L(83.961), .geoid =  1},
+  {.e = L(454002.822), .n =  L(340834.941), .elevation =  L(45.252), .geoid =  1}, // *
+  {.e = L(438710.908), .n =  L(114792.248), .elevation =  L(54.029), .geoid =  1},
+  {.e = L(250359.798), .n =   L(62016.567), .elevation = L(163.081), .geoid =  1},
+  {.e = L(449816.359), .n =   L(75335.859), .elevation =  L(48.570), .geoid =  1}, // *
+  {.e = L(440725.061), .n = L(1107878.445), .elevation = L(100.992), .geoid =  6}, // *
+  {.e = L(299721.879), .n =   L(967202.99), .elevation =  L(46.011), .geoid =  1},
+  {.e =  L(91492.135), .n =   L(11318.801), .elevation =  L(46.882), .geoid =  2},
+  {.e =      L(0.000), .n =       L(0.000), .elevation =   L(0.000), .geoid =  0},
+  {.e =      L(0.000), .n =       L(0.000), .elevation =   L(0.000), .geoid =  0},
+  {.e =   L(9587.897), .n =  L(899448.993), .elevation =  L(43.424), .geoid =  5},
+  {.e =  L(71713.120), .n =  L(938516.401), .elevation =  L(83.594), .geoid =  9},
+  {.e = L(180862.449), .n = L(1029604.111), .elevation =  L(85.197), .geoid = 10},
+  {.e = L(261596.767), .n = L(1025447.599), .elevation =  L(46.348), .geoid = 11}, // *
+  {.e = L(395999.656), .n = L(1138728.948), .elevation =  L(89.901), .geoid = 12},
+  {.e = L(421300.513), .n = L(1072147.236), .elevation =  L(50.951), .geoid =  8},
+  {.e = L(330398.311), .n = L(1017347.013), .elevation =  L(47.978), .geoid =  7},
+  {.e = L(337898.195), .n =  L(981746.359), .elevation =  L(48.631), .geoid =  7},
+  {.e = L(334198.101), .n =  L(982046.419), .elevation =  L(48.439), .geoid =  1},
+  
+  {.e =      L(0.000), .n =       L(0.000), .elevation =   L(0.000), .geoid =  0},
+  {.e =      L(0.000), .n =       L(0.000), .elevation =   L(0.000), .geoid =  0},
+  {.e =      L(0.000), .n =       L(0.000), .elevation =   L(0.000), .geoid =  0},
+  {.e =      L(0.000), .n =       L(0.000), .elevation =   L(0.000), .geoid =  0},
+};

data/ext/ostn02c/README.textile

@@ -0,0 +1,165 @@
+*This is a C implementation of Ordnance Survey's definitive transformation model "OSTN02":http://www.ordnancesurvey.co.uk/oswebsite/gps/osnetfreeservices/about/surveying_osnet.html#6 and Geoid model "OSGM02":http://www.ordnancesurvey.co.uk/oswebsite/gps/osnetfreeservices/about/surveying_osnet.html#7, with tests.*
+
+It's intended to power a future update of my "GridPoint GB":http://mackerron.com/gridpointgb/ iOS app. It also includes a simple command-line tool. 
+
+
+h2. Licence
+
+I'm releasing the code under the "MIT licence":http://www.opensource.org/licenses/mit-license.php (note, however, that OSTN02 and OSGM02 are trademarks of Ordnance Survey, and that the OSTN02 and OSGM02 data are © Crown copyright 2002. All rights reserved).
+
+
+h2. Installing the command-line tool
+
+h3. For Mac
+
+You can "download a binary for Mac OS X 10.4+, Intel 32/64-bit":http://jawj.github.com/OSTN02C/ostn02c.bz2. You'll need to uncompress, @chmod +x@ and @mv@ this somewhere appropriate.
+
+Alternatively, use "Homebrew":http://mxcl.github.com/homebrew/. In Terminal.app, type:
+
+@brew install http://jawj.github.com/OSTN02C/ostn02c.rb@
+
+h3. From source
+
+Otherwise, with the relevant build tools installed -- Xcode on the Mac, @sudo aptitude install build-essential@ on Debian/Ubuntu, etc. -- download or clone the source to your machine, and compile like so:
+
+@gcc OSTN02/*.c -std=gnu99 -D_GNU_SOURCE -lm -Wall -O2 -o ostn02c@
+
+To compile with long double precision arithmetic (not recommended, since the outputs are the same to within 1mm), add the option @-DUSE_LONG@. To suppress fancy formatting (bold/inverse/underlined) in the tool's output, add the option @-DUNFANCY_OUTPUT@.
+
+
+h2. Using the command-line tool
+
+The command-line tool works like this:
+
+bc.. dyn204:OSTN02 George$ ostn02c help
+
+OSTN02C -- https://github.com/jawj/OSTN02C -- Built Feb 14 2012 11:53:48 (double precision)
+
+This tool converts coordinates between ETRS89 (WGS84, GPS) lat/lon/elevation and OSGB36 easting/northing/elevation.
+Conversions make use of Ordnance Survey's OSTN02 and OSGM02 transformations, and should thus be accurate to within 1m.
+
+Usage: ostn02c gps-to-grid [lat lon elevation] converts ETRS89 to OSGB36
+       ostn02c grid-to-gps [easting northing elevation] converts OSGB36 to ETRS89
+       ostn02c list-geoids lists the geoid datum flags, names and regions
+       ostn02c test checks embedded data integrity and runs conversion tests with known coordinates
+       ostn02c help displays this message
+
+The conversion commands gps-to-grid and grid-to-gps can be used in two ways:
+* Given a set of coordinates as command-line arguments, they will convert this set with user-friendly output
+* Given no command-line arguments, they will convert batches of coordinates, reading from STDIN and writing to STDOUT
+
+In the batch conversion case:
+* Input rows must have 3 columns -- lat or easting, lon or northing, elevation -- with any reasonable separator (,;:| \t)
+* Output rows have 4 columns -- easting or lat, northing or lon, elevation, geoid datum flag -- separated with tabs
+* In case of out-of-range input coordinates, all output columns will be zero
+* Malformatted input terminates processing and results in a non-zero exit code
+
+Software copyright (c) George MacKerron 2012 (http://mackerron.com)
+Released under the MIT licence (http://www.opensource.org/licenses/mit-license.php)
+
+OSTN02 and OSGM02 are trademarks of Ordnance Survey
+Embedded OSTN02 and OSGM02 data (c) Crown copyright 2002. All rights reserved.
+
+
+dyn204:OSTN02 George$ ostn02c gps-to-grid 51.0 -0.5 100.0
+
+ETRS89 in  lat:   51.000000, lon:   -0.500000, elevation:  100.000
+OSGB36 out   E:  505349.663,   N:  123360.984, elevation:   54.635 (UK mainland / Newlyn)
+
+
+dyn204:OSTN02 George$ ostn02c grid-to-gps 505349.663 123360.984 54.635
+
+OSGB36 in    E:  505349.663,   N:  123360.984, elevation:   54.635 (UK mainland / Newlyn)
+ETRS89 out lat:   51.000000, lon:   -0.500000, elevation:  100.000
+
+
+dyn204:OSTN02 George$ echo "51.0, -0.5, 100.0
+> 51.5, -1.0, 50.0" | ostn02c gps-to-grid
+505349.663	123360.984	54.635	1
+469509.184	178369.364	3.360	1
+
+dyn204:OSTN02 George$ echo $?
+0
+
+
+dyn204:OSTN02 George$ echo "51.0, -0.5, 100.0
+> 20.0 40.0 0.0
+> an invalid line
+> 51.5, -1.0, 50.0" | ostn02c gps-to-grid
+505349.663	123360.984	54.635	1
+0.000	0.000	0.000	0
+
+dyn204:OSTN02 George$ echo $?
+1
+
+
+dyn204:OSTN02 George$ ostn02c list-geoids
+
+Flag  Datum          Region
+   0  N/A            Outside model boundary
+   1  Newlyn         UK mainland
+   2  St Marys       Scilly Isles
+   3  Douglas02      Isle of Man
+   4  Stornoway      Outer Hebrides
+   5  St Kilda       St Kilda
+   6  Lerwick        Shetland Isles
+   7  Newlyn         Orkney Isles
+   8  Fair Isle      Fair Isle
+   9  Flannan Isles  Flannan Isles
+  10  North Rona     North Rona
+  11  Sule Skerry    Sule Skerry
+  12  Foula          Foula
+  13  Malin Head     Republic of Ireland
+  14  Belfast        Northern Ireland
+  
+  
+dyn204:OSTN02 George$ ostn02c test
+
+Original CRC32 (data):  790474494
+Computed CRC32 (data):  790474494
+
+Original CRC32 (index): 244629328
+Computed CRC32 (index): 244629328
+
+ETRS89 actual   lat:   53.779110, lon:   -3.040455, elevation:   64.940
+OSGB36 actual     E:  331534.552,   N:  431920.792, elevation:   12.636 (UK mainland / Newlyn)
+ETRS89 computed lat:   53.779110, lon:   -3.040455, elevation:   64.940
+OSGB36 computed   E:  331534.552,   N:  431920.792, elevation:   12.636 (UK mainland / Newlyn)
+
+ETRS89 actual   lat:   51.427547, lon:   -2.544076, elevation:  104.018
+OSGB36 actual     E:  362269.979,   N:  169978.688, elevation:   54.467 (UK mainland / Newlyn)
+ETRS89 computed lat:   51.427547, lon:   -2.544076, elevation:  104.018
+OSGB36 computed   E:  362269.979,   N:  169978.688, elevation:   54.467 (UK mainland / Newlyn)
+
+[...]
+
+ETRS89 actual   lat:  -51.000000, lon:  180.000000, elevation:  100.000
+OSGB36 actual     E:       0.000,   N:       0.000, elevation:    0.000 (Outside model boundary / N/A)
+OSGB36 computed   E:       0.000,   N:       0.000, elevation:    0.000 (Outside model boundary / N/A)
+
+ETRS89 actual   lat:    0.000000, lon:    0.000000, elevation:  100.000
+OSGB36 actual     E:       0.000,   N:       0.000, elevation:    0.000 (Outside model boundary / N/A)
+OSGB36 computed   E:       0.000,   N:       0.000, elevation:    0.000 (Outside model boundary / N/A)
+
+92 tests; 92 passed; 0 failed
+
+
+
+h3. Output buffering
+
+If you're using the command line tool from another script (e.g. from Ruby or Python), alternately writing coordinates to its STDIN and reading the converted results from its STDOUT, you'll need to ensure that your I/O isn't being buffered. 
+
+To help with this, the tool checks for an environment variable named OSTN02C_LINE_BUFFERED, and does buffering at line level only (i.e. output is flushed after every newline character) if it's set.
+
+As an example, you can use this snippet to convert WGS84 to OSGB36 in Ruby:
+
+bc. @ostn02 = IO.popen([{'OSTN02C_LINE_BUFFERED' => 'Y'}, 'ostn02c', 'gps-to-grid'], 'r+')
+@ostn02.sync = true  # this is actually the default on my system
+def ll_to_en(lat, lon, elev)
+  @ostn02.puts "#{lat} #{lon} #{elev}"
+  osgb = @ostn02.gets.split("\t")
+  datum = osgb[3].to_i
+  return nil unless datum > 0
+  osgb[0..2].map(&:to_f)
+end
+

data/ext/ostn02c/csv-to-struct-array.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# this script processes the OSTN02/OSGM02 data in OS-supplied CSV format
+# into a packed array of structs, and an index thereto
+
+require 'CSV'
+puts 'loading'
+data = []
+last_n = nil
+CSV.foreach("OSTN02_OSGM02_GB.txt") do |csv_row|
+  e     = csv_row[1].to_i / 1000
+  n     = csv_row[2].to_i / 1000
+  dflag = csv_row[6].to_i
+  if dflag == 0
+    eshift = nshift = gshift = 0
+  else
+    # these offsets (-86000, 82000, -43000) minimise the number of bits required to store
+    eshift = csv_row[3].sub('.', '').to_i - 86000  
+    nshift = csv_row[4].sub('.', '').to_i + 82000
+    gshift = csv_row[5].sub('.', '').to_i - 43000
+  end
+  if n != last_n
+    data.push([]) 
+    print n.to_s + ' '
+  end
+  data.last.push(e: e, n: n, dflag: dflag, eshift: eshift, nshift: nshift, gshift: gshift)
+  last_n = n
+end
+
+puts "\n\ntrimming"
+data.each do |row|
+  print row[0][:n].to_s + ' '
+  first_non_zero_index = row.find_index { |cell| cell[:dflag] != 0 }
+  if first_non_zero_index.nil?
+    row.clear
+    next
+  end
+  row.slice!(0...first_non_zero_index)
+  last_non_zero_index = row.length - row.reverse_each.find_index { |cell| cell[:dflag] != 0 }  # actually the index of the following zero
+  row.slice!(last_non_zero_index..row.length)
+  print row.length.to_s + ', '
+end
+
+c_notice = %{
+// OSTN02/OSGM02 data (derived from OSTN02_OSGM02_GB.txt in http://www.ordnancesurvey.co.uk/oswebsite/gps/docs/OSTN02_OSGM02files.zip)
+// © Crown copyright 2002. All rights reserved
+
+}
+
+puts "\n\nwriting"
+indices_written = data_written = 0
+File.open("shifts.index.data", "w") do |index_file|
+  index_file.puts(c_notice + 'static const OSTN02Index OSTN02Indices[] = {')
+  File.open("shifts.data", "w") do |data_file|
+    data_file.puts(c_notice + 'static const OSTN02Datum OSTN02Data[] = {')
+    data.each do |row|
+      print row.empty? ? '- ' : row[0][:n].to_s + ' '
+      emin = row.empty? ? 0 : row.first[:e]
+      index_file.write(indices_written == 0 ? ' ' : ',')
+      index_file.puts("{#{emin},#{row.length},#{data_written}}")
+      indices_written += 1
+      row.each do |cell|
+        data_file.write(data_written == 0 ? ' ' : ',')
+        data_file.puts("{#{cell[:eshift]},#{cell[:nshift]},#{cell[:gshift]},#{cell[:dflag]}}")
+        data_written += 1
+      end
+    end
+    data_file.puts('};')
+  end 
+  index_file.puts('};')
+end

data/lib/national_grid/version.rb

@@ -1,3 +1,3 @@
 module NationalGrid
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/national_grid.gemspec

@@ -1,7 +1,31 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "national_grid/version"
 
+module Files
+  module_function
+
+  def all
+    git_files + git_submodule_files
+  end
+
+  def git_files(dir = ".")
+    Dir.chdir File.expand_path(dir, __dir__) do
+      `git ls-files -z`.split("\x0")
+    end
+  end
+
+  def git_submodules
+    `git submodule -q foreach 'printf "$path\\0"'`.split("\x0")
+  end
+
+  def git_submodule_files
+    git_submodules.flat_map {|submodule|
+      git_files(submodule).map {|file| File.join(submodule, file)}
+    }
+  end
+end
+
 Gem::Specification.new do |spec|
   spec.name          = "national_grid"
   spec.version       = NationalGrid::VERSION
@@ -11,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/haines/national_grid"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = Files.all
   spec.test_files    = spec.files.grep(%r{^test/})
   spec.require_paths = ["lib"]
   spec.extensions    = ["ext/national_grid/extconf.rb"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: national_grid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Haines
@@ -90,6 +90,25 @@ files:
 - ext/national_grid/national_grid_latitude_longitude.c
 - ext/national_grid/national_grid_latitude_longitude.h
 - ext/ostn02c.rb
+- ext/ostn02c/.gitignore
+- ext/ostn02c/OSTN02.xcodeproj/project.pbxproj
+- ext/ostn02c/OSTN02.xcodeproj/project.xcworkspace/contents.xcworkspacedata
+- ext/ostn02c/OSTN02/OSTN02.c
+- ext/ostn02c/OSTN02/OSTN02.h
+- ext/ostn02c/OSTN02/constants.data
+- ext/ostn02c/OSTN02/crc32.c
+- ext/ostn02c/OSTN02/crc32.h
+- ext/ostn02c/OSTN02/dblRelated.h
+- ext/ostn02c/OSTN02/explorerMaps.data
+- ext/ostn02c/OSTN02/fancyOut.h
+- ext/ostn02c/OSTN02/geoids.data
+- ext/ostn02c/OSTN02/gridRef.data
+- ext/ostn02c/OSTN02/main.c
+- ext/ostn02c/OSTN02/shifts.data
+- ext/ostn02c/OSTN02/shifts.index.data
+- ext/ostn02c/OSTN02/testCoords.data
+- ext/ostn02c/README.textile
+- ext/ostn02c/csv-to-struct-array.rb
 - lib/national_grid.rb
 - lib/national_grid/easting_northing.rb
 - lib/national_grid/inspect.rb