1# PROJ
2
3
4PROJ is a generic coordinate transformation software, that transforms
5coordinates from one coordinate reference system (CRS) to another.
6This includes cartographic projections as well as geodetic transformations.
7
8For more information on the PROJ project please see the web page at:
9
10https://proj.org/
11
12The PROJ mailing list can be found at:
13
14https://lists.osgeo.org/mailman/listinfo/proj/
15
16See the NEWS file for changes between versions.
17
18The following command line utilities are included in the PROJ package:
19
20- `proj`: for cartographic projection of geodetic coordinates.
21- `cs2cs`: for transformation from one CRS to another CRS.
22- `geod`: for geodesic (great circle) computations.
23- `cct`: for generic Coordinate Conversions and Transformations.
24- `gie`: the Geospatial Integrity Investigation Environment.
25- `projinfo`: for geodetic object and coordinate operation queries.
26- `projsync`: for synchronizing PROJ datum and transformation support data.
27
28> More information on the utilities can be found on the [PROJ website](https://proj.org/apps).
29
30## Installation
31
32Consult the [Installation](https://proj.org/install.html) page of the official
33documentation.
34For builds on the master branch, [install.rst](https://github.com/OSGeo/PROJ/blob/master/docs/source/install.rst)
35might be more up-to-date.
36
37## Distribution files and format
38
39Sources are distributed in one or more files.  The principle elements
40of the system are stored in a compressed tar file named `proj-x.y.z.tar.gz` where
41"x" will indicate the major release number, "y" indicates the minor release
42number, and "z" indicates the patch number of the release.
43
44In addition to the PROJ software package, distributions of datum
45conversion grid files and PROJ parameter files are also available.
46The grid package is distributed under the name `proj-data-x.y.zip`,
47where "x" is the major release version and "y" is the minor release
48version numbers. The resource packages can be downloaded from the
49[PROJ website](https://proj.org/download.html).
50
51More info on the contents of the proj-data package can be
52found at the
53[PROJ-data GitHub repository](https://github.com/OSGeo/PROJ-data).
54
55The resource file packages should be extracted to `PROJ_LIB`
56where PROJ will find them after installation. The default location of
57`PROJ_LIB` on UNIX-based systems is `/usr/local/share/proj` but it may
58be changed to a different directory. On Windows you have to define
59`PROJ_LIB` yourself.
60
61As an alternative to installing the data package on the local system,
62the resource files can be retrieved on-the-fly from the
63[PROJ CDN](https://cdn.proj.org/). A [network-enabled](https://proj.org/usage/network.html) PROJ build, will
64automatically fetch resource files that are not present locally from the
65CDN.
66
67
68## Citing PROJ in publications
69
70See [CITATION](CITATION)
71