aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/operations/transformations/deformation.rst2
-rw-r--r--docs/source/operations/transformations/xyzgridshift.rst8
-rw-r--r--docs/source/references.bib2
-rw-r--r--docs/source/resource_files.rst19
-rw-r--r--docs/source/usage/environmentvars.rst2
5 files changed, 26 insertions, 7 deletions
diff --git a/docs/source/operations/transformations/deformation.rst b/docs/source/operations/transformations/deformation.rst
index b45c5e2b..aefda3a6 100644
--- a/docs/source/operations/transformations/deformation.rst
+++ b/docs/source/operations/transformations/deformation.rst
@@ -92,7 +92,7 @@ Parameters
.. option:: +xy_grids=<list>
- Comma-separated list of grids to load. If a grid is prefixed by an `@` the
+ Comma-separated list of grids to load. If a grid is prefixed by an ``@`` the
grid is considered optional and PROJ will the not complain if the grid is
not available.
diff --git a/docs/source/operations/transformations/xyzgridshift.rst b/docs/source/operations/transformations/xyzgridshift.rst
index c49b7592..30537032 100644
--- a/docs/source/operations/transformations/xyzgridshift.rst
+++ b/docs/source/operations/transformations/xyzgridshift.rst
@@ -21,16 +21,16 @@ translation values from a grid. The grid is referenced against either the
2D geographic CRS corresponding to the input (or sometimes output) CRS.
This method is described (in French) in :cite:`NTF_88`
-and as EPSG operation methode code 9655 in :cite:`IOGP2018` (§2.4.4.1.1
+and as EPSG operation method code 9655 in :cite:`IOGP2018` (§2.4.4.1.1
France geocentric interpolation).
The translation in the grids are added to the input coordinates in the forward direction,
and subtracted in the reverse direction.
-By default (if grid_ref=input_crs), in the forward direction, the input coordinates
+By default (if ``grid_ref=input_crs``), in the forward direction, the input coordinates
are converted to their geographic equivalent to directly read and interpolate from
the grid. In the reverse direction, an iterative method is used to be able to find
the grid locations to read.
-If grid_ref=output_crs is used, then the reverse strategy is applied: iterative
+If ``grid_ref=output_crs`` is used, then the reverse strategy is applied: iterative
method in the forward direction, and direct read in the reverse direction.
Example
@@ -62,7 +62,7 @@ Required
.. option:: +grids=<list>
- Comma-separated list of grids to load. If a grid is prefixed by an `@` the
+ Comma-separated list of grids to load. If a grid is prefixed by an ``@`` the
grid is considered optional and PROJ will the not complain if the grid is
not available.
diff --git a/docs/source/references.bib b/docs/source/references.bib
index 8e527ea1..912929c3 100644
--- a/docs/source/references.bib
+++ b/docs/source/references.bib
@@ -231,7 +231,7 @@
}
@TechReport{NTF_88,
- Title = {Grille de parametres de transformation de coordonnees - GR3DF97A - Notice d'utilisation},
+ Title = {Grille de parametres de transformation de coordonnees - {GR3DF97A} - Notice d'utilisation},
Author = {IGN},
Institution = {Service de Geodesie et Nivellement, Institut Geographique National},
Year = {1997},
diff --git a/docs/source/resource_files.rst b/docs/source/resource_files.rst
index ea02fd4b..3684a948 100644
--- a/docs/source/resource_files.rst
+++ b/docs/source/resource_files.rst
@@ -23,21 +23,34 @@ The following paths are checked in order:
- For transformation grids that have an explict relative or absolute path,
the directory specified in the grid filename.
+
- Path resolved by the callback function set with
the :c:func:`proj_context_set_file_finder`. If it is set, the next tests
will not be run.
+
- Path(s) set with the :c:func:`proj_context_set_search_paths`. If set, the
next tests will not be run.
+
+- The PROJ user writable directory, which is :
+
+ * on Windows, ${LOCALAPPDATA}/proj
+ * on MacOSX, ${HOME}/Library/Logs/proj
+ * on other platforms (Linux), ${XDG_DATA_HOME}/proj if :envvar:`XDG_DATA_HOME`
+ is defined. Else ${HOME}/.local/share/proj
+
- Path(s) set with by the environment variable :envvar:`PROJ_LIB`.
On Linux/MacOSX/Unix, use ``:`` to separate paths. On Windows, ``;``
+
- On Windows, the *..\\share\\proj\\* and its contents are found automatically
at run-time if the installation respects the build structure. That is, the
binaries and proj.dll are installed under *..\\bin\\*, and resource files
are in *..\\share\\proj\\*.
+
- A path built into PROJ as its resource installation directory (whose value is
$(pkgdatadir)), for builds using the Makefile build system. Note, however,
that since this is a hard-wired path setting, it only works if the whole
PROJ installation is not moved somewhere else.
+
- The current directory
When networking capabilities are enabled, either by API with the
@@ -77,6 +90,12 @@ Its default content is:
; Can be overriden with the PROJ_NETWORK_ENDPOINT environment variable.
cdn_endpoint = https://cdn.proj.org
+ cache_enabled = on
+
+ cache_size_MB = 100
+
+ cache_ttl_sec = 86400
+
Transformation grids
-------------------------------------------------------------------------------
diff --git a/docs/source/usage/environmentvars.rst b/docs/source/usage/environmentvars.rst
index 24ae4a45..31a74e9a 100644
--- a/docs/source/usage/environmentvars.rst
+++ b/docs/source/usage/environmentvars.rst
@@ -71,6 +71,6 @@ done by setting the variable with no content::
.. versionadded:: 7.0.0
Define the endpoint of the CDN storage. Normally defined through the proj.ini
- configuration file locale in PROJ_LIB.
+ configuration file locale in :envvar:`PROJ_LIB`.
Alternatively, the :c:func:`proj_context_set_url_endpoint` function can
be used.