Merge pull request #166 from GeoscienceAustralia/doc_update_mar26

Docs updated for March 2026

Author: Kyran-Cook

docs/features/constants.rst

@@ -130,7 +130,34 @@ For :class:`~geodepy.constants.Transformation`:
 +-----------------------------+---------------------+-------------------------------------------------------------+
 | itrf2020_to_itrf88          | Transformation      | ITRF2020 to ITRF88                                          |
 +-----------------------------+---------------------+-------------------------------------------------------------+
-
+| wgs84g2296_to_itrf2020      | Transformation      | WGS84(G2296) to ITRF2020                                    |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g2139_to_wgs84g2296    | Transformation      | WGS84(G2139) to WGS84(G2296)                                |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g1762_to_wgs84g2296    | Transformation      | WGS84(G1762) to WGS84(G2296)                                |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g2139_to_itrf2014      | Transformation      | WGS84(G2139) to ITRF2014                                    |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g1762_to_itrf2008      | Transformation      | WGS84(G1762) to ITRF2008                                    |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| itrf2005_to_wgs84g1674      | Transformation      | ITRF2005 to WGS84(G1674)                                    |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g1674_to_wgs84g1762    | Transformation      | WGS84(G1674) to WGS84(G1762)                                |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g1150_to_itrf2000      | Transformation      | WGS84(G1150) to ITRF2000                                    |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g873_to_itrf97         | Transformation      | WGS84(G873) to ITRF97                                       |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g873_to_itrf96         | Transformation      | WGS84(G873) to ITRF96                                       |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g873_to_itrf94         | Transformation      | WGS84(G873) to ITRF94                                       |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84g730_to_itrf91         | Transformation      | WGS84(G730) to ITRF91                                       |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84trans_to_itrf90        | Transformation      | WGS84 (Transit) to ITRF90                                   |
++-----------------------------+---------------------+-------------------------------------------------------------+
+| wgs84ensemble_to_itrf2014   | Transformation      | WGS84 Ensemble to ITRF2014                                  |
++-----------------------------+---------------------+-------------------------------------------------------------+
 
 All other combinations of ITRF transformations are available.
 

docs/features/transform.rst

@@ -13,6 +13,8 @@ Helmert Transformations
 
 .. autofunction:: geodepy.transform.conform14
 
+.. autofunction:: geodepy.transform.plate_motion_transformation
+
 Common Geodetic Transformations
 --------------------------------
 

docs/installation.rst

@@ -33,8 +33,9 @@ The requirements can be seen below.
 .. code::
 
     NumPy
-    SciPy
-    GDAL #only needed for height module
+    SciPy # only needed for height module
+    GDAL # only needed for height module
+    Pandas # only for sinex module
 
 GDAL is only used for the heights module and sometimes can be difficult to install. For more information on 
 installing GDAL see the `GDAL pypi <https://pypi.org/project/GDAL/>`_ page.

docs/tutorials/timedeptranstut.rst

@@ -108,30 +108,29 @@ Now we have an ITRF2014 coordinate at 1/1/2007. Now this needs to be moved to th
 done using the ITRF2014 to GDA2020 transformation which approximates plate motion in Australia. To complete 
 this transformation on another plate a different plate motion model should be used. 
 
-Some careful math needs to be completed here. To go from 2007 to 2030, 23 years 
-of plate motion needs to be added. The reference epoch of the ITRF2014 to GDA2020 transformation is 2020. 
-As such 23 needs to be subtracted from 2020 to get the desired motion. This means the epoch 1/1/1993 should be entered.
+The plate_motion_transformation function can be used to move coordinates in time. This avoids the need to 
+calculate the difference between the reference epoch and the epoch required. This can be seen below.
 
 .. caution::
     Transformations using the plate motion model of itrf2014_to_gda2020 should only be completed for epochs between
     2005 - 2035. For transformations outside of this range refer to the :ref:`next <tutorials/transold>` section.
 
-
 .. code:: python
 
-    x, y, z, vcv = geodepy.transform.conform14(
+    x, y, z, vcv = geodepy.transform.plate_motion_transformation(
         x, 
         y, 
-        z, 
-        date(1997, 1, 1), #plate motion epoch
+        z,
+        date(2007, 1, 1), #from epoch
+        date(2030, 1, 1), #to epoch
         geodepy.constants.itrf2014_to_gda2020 #transformation paramters
     )
 
     print(x, y, z)
 
-    >>-4050763.516973 4220880.699906 -2533399.176976
+    >>-4050763.517081 4220880.699892 -2533399.176829
 
-This is now the ITRF2014 corrdinate at 1/1/2030. Now we can convert this ITRF2014 cooridnate to ITRF2020.
+This is now the ITRF2014 corrdinate at 1/1/2030. Now we can convert this ITRF2014 coordinate to ITRF2020.
 
 .. code:: python
 
@@ -145,7 +144,7 @@ This is now the ITRF2014 corrdinate at 1/1/2030. Now we can convert this ITRF201
 
     print(x, y, z)
 
-    >>-4050763.517274 4220880.704079 -2533399.182440
+    >>-4050763.517382 4220880.704065 -2533399.182293
 
 This is the final cooridnate in ITRF2020 at 1/1/2030.