aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorKristian Evers <kristianevers@gmail.com>2018-05-10 21:19:37 +0200
committerKristian Evers <kristianevers@gmail.com>2018-05-12 12:22:19 +0200
commit609873534e6407ba0ca5c3bb6ff40425222d6a9b (patch)
tree2a72ad759bbe1df9ca1f5a6179dc75223ce145ab /docs/source
parentf5eeef8a5933d41f229f6551c6612daa5d61a7b5 (diff)
downloadPROJ-609873534e6407ba0ca5c3bb6ff40425222d6a9b.tar.gz
PROJ-609873534e6407ba0ca5c3bb6ff40425222d6a9b.zip
Update install doc page with build instructions
Also added more possible ways to install from package managers. Removed links to externally build binaries from download page.
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/download.rst33
-rw-r--r--docs/source/install.rst123
2 files changed, 126 insertions, 30 deletions
diff --git a/docs/source/download.rst b/docs/source/download.rst
index 510751c4..32ce8012 100644
--- a/docs/source/download.rst
+++ b/docs/source/download.rst
@@ -4,7 +4,11 @@
Download
================================================================================
+Here you can download current and previous releases of PROJ. We only supply a
+distribution of the source code and various resource files archives. See
+:ref:`install` for information on how to get pre-built packages of PROJ.
+.. _current_release:
Current Release
--------------------------------------------------------------------------------
@@ -38,32 +42,3 @@ Past Releases
.. _`proj-datumgrid-oceania-1.0.zip`: http://download.osgeo.org/proj/proj-datumgrid-oceania-1.0.zip
.. _`md5`: http://download.osgeo.org/proj/proj-5.0.1.tar.gz.md5
.. _`proj.pdf`: https://raw.githubusercontent.com/OSGeo/proj.4/gh-pages/proj.pdf
-
-
-Binaries
---------------------------------------------------------------------------------
-
-Linux
-................................................................................
-
-* `RedHat RPMs <http://yum.postgresql.org>`__
-* `SUSE <http://download.opensuse.org/repositories/Application:/Geo/ openSUSE Application:Geo Repository>`__
-* `Debian <http://packages.debian.org/proj>`__
-* `pkgsrc <http://pkgsrc.se/misc/proj pkgsrc package>`__
-* `Delphi <http://www.triplexware.huckfinn.de/geogfix.html#proj>`__
-
-Docker
-................................................................................
-
-A `Docker`_ image with just PROJ binaries and a full compliment of grid shift
-files is available on `DockerHub`_:
-
-.. _`Docker`: https://docker.org
-.. _`DockerHub`: https://hub.docker.com/r/osgeo/proj.4/
-
-Windows
-................................................................................
-
-* `OSGeo4W`_ contains 32-bit and 64-bit Windows binaries, including support for many :ref:`grids <resource_files>`.
-
-.. _`OSGeo4W`: https://trac.osgeo.org/osgeo4w/
diff --git a/docs/source/install.rst b/docs/source/install.rst
index 5b3256a1..03e6bc9d 100644
--- a/docs/source/install.rst
+++ b/docs/source/install.rst
@@ -9,6 +9,34 @@ yourself. Below are guides for installing on Windows, Linux and Mac OS X. This
is a good place to get started if this is your first time using PROJ. More
advanced users may want to compile the software themselves.
+Installation from package management systems
+################################################################################
+
+
+Cross platform
+--------------------------------------------------------------------------------
+
+PROJ is also available via cross platform package managers.
+
+Conda
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+The conda package manager includes several PROJ packages. We recommend installing
+from the ``conda-forge`` channel::
+
+ conda install -c conda-forge proj4
+
+Docker
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+A `Docker`_ image with just PROJ binaries and a full compliment of grid shift
+files is available on `DockerHub`_. Get the package with::
+
+ docker pull osgeo/proj.4
+
+.. _`Docker`: https://docker.org
+.. _`DockerHub`: https://hub.docker.com/r/osgeo/proj.4/
+
Windows
--------------------------------------------------------------------------------
@@ -69,6 +97,99 @@ On Red Hat based system packages are installed with yum::
Mac OS X
--------------------------------------------------------------------------------
-On OS X PROJ can be installed via the Homebrew package manager:
+On OS X PROJ can be installed via the Homebrew package manager::
brew install proj
+
+PROJ is also available from the MacPorts system::
+
+ sudo ports install proj
+
+Compilation and installation from source code
+################################################################################
+
+The classical way of installing PROJ is via the source code distribution. The
+most recent version is available from the :ref:`download page<current_release>`.
+You will need that and at least the standard *proj-datumgrid* package for a
+successful installation.
+The following guides show how to compile and install the software using the
+Autotools and CMake build systems.
+
+Autotools
+--------------------------------------------------------------------------------
+
+FSF's configuration procedure is used to ease installation of the PROJ system.
+
+.. note::
+ The Autotools build system is only available on UNIX-like systems.
+ Follow the CMake installation guide if you are not using a UNIX-like
+ operating system.
+
+The default destination path prefix for installed files is ``/usr/local``.
+Results from the installation script will be placed into subdirectories ``bin``,
+``include``, ``lib``, ``man/man1`` and ``man/man3``. If this default path prefix
+is proper, then execute::
+
+ ./configure
+
+If another path prefix is required, then execute::
+
+ ./configure --prefix=/my/path
+
+In either case, the directory of the prefix path must exist and be writable by
+the installer.
+
+Before proceeding with the installation we need to add the datum grids. Unzip
+the contents of the *proj-datumgrid* package into ``nad/``::
+
+ unzip proj-datumgrid-1.7.zip -d proj-5.0.1/nad/
+
+The installation will automatically move the grid files to the correct location.
+Alternatively the grids can be installed manually in the directory pointed to
+by the :envvar:`PROJ_LIB` environment variable. The default location is
+``/usr/local/share/proj``.
+
+With the grid files in place we can now build and install PROJ::
+
+ make
+ make install
+
+The install target will create, if necessary, all required sub-directories.
+
+Tests are run with::
+
+ make check
+
+The test suite requires that the proj-datumgrid package is installed in
+:envvar:`PROJ_LIB`.
+
+
+CMake
+--------------------------------------------------------------------------------
+
+With the CMake build system you can compile and install PROJ on more or less any
+platform. After unpacking the source distribution archive step into the source-
+tree::
+
+ cd proj-5.0.1
+
+Create a build directory and step into it::
+
+ mkdir build
+ cd build
+
+From the build directory you can now configure CMake and build the binaries::
+
+ cmake ..
+ cmake --build .
+
+On Windows, one may need to specify generator::
+
+ cmake -G "Visual Studio 15 2017" ..
+
+Tests are run with::
+
+ ctest
+
+The test suite requires that the proj-datumgrid package is installed
+in :envvar:`PROJ_LIB`.