Debian Codegraph @

README

raw
1 Geo::Coordinates::OSGB
2 Geo::Coordinates::OSGB::Grid
3 Geo::Coordinates::OSGB::Maps
4 ----------------------------
5
6 Geo::Coordinates::OSGB provides routines to convert latitude and
7 longitude coordinates to and from transverse Mercator grid references;
8 the routines are designed for use with the British national grid.
9
10 - The OSGB module provides routines to convert between
11 latitude/longitude coordinates in the WGS84 or OSGB36 models and the
12 British National Grid.
13
14 - The Grid module includes some useful extra routines to parse and
15 format grid references in a variety of popular forms (including which
16 map your point appears on).
17
18 - The Maps module provides data for British maps.
19
20 Note that due to the nature of this type of conversion, the conversions
21 are only really useful in the vicinity of the British Isles. If you are
22 elsewhere on the planet you need an implementation designed for your
23 neighbourhood.
24
25
26 INSTALLATION
27
28 This package installs in the regular Perl way. You don't need the C
29 compiler and as far as I know there are no platform dependencies.
30 Either use your local package tool, or just try
31
32 [sudo] perl -MCPAN -e "install Geo::Coordinates::OSGB"
33
34 For the die hards, the package can also be installed by hand; just unzip
35 it to some temporary home, then do the usual thing:
36
37 Perl Makefile.PL
38 make
39 make test
40 [sudo] make install
41
42 The full suite of tests takes about 1 second on my machine. You may or
43 may not need sudo depending on how you have set up your system.
44
45 DEPENDENCIES
46
47 perl 5.10 or better
48 File::Share
49
50 COPYRIGHT AND LICENCE
51
52 Copyright (C) 2002-2017 Toby Thurston
53
54 OSTN15 transformation data included in this module is freely available
55 from the Ordnance Survey under the BSD License but remains Crown
56 Copyright (C) 2016.
57
58 This program is free software; you can redistribute it and/or modify it
59 under the terms of the GNU General Public License as published by the
60 Free Software Foundation; either version 2 of the License, or (at your
61 option) any later version.
62
63 This program is distributed in the hope that it will be useful, but
64 WITHOUT ANY WARRANTY; without even the implied warranty of
65 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
66 General Public License for more details.
67
68 You should have received a copy of the GNU General Public License along
69 with this program; if not, write to the Free Software Foundation, Inc.,
70 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
71
72 All feedback gratefully received.