diff --git a/docs/community/contributing.rst b/docs/community/contributing.rst index 5bc8606..c1a65f5 100644 --- a/docs/community/contributing.rst +++ b/docs/community/contributing.rst @@ -1,18 +1,18 @@ Contributing ================== -We welcome contributions from the community to help improve GeodePy! Whether you're fixing bugs, -adding new features, or enhancing documentation, your input is valuable. Open source projects -live and die based on the support they recieve. +We welcome contributions from the community to help improve GeodePy! Whether you're fixing bugs, +adding new features, or enhancing documentation, your input is valuable. Open source projects +live and die based on the support they receive. -This document outlines some of the guidlines and advice for contributing to GeodePy. +This document outlines some of the guidelines and advice for contributing to GeodePy. Code of Conduct ---------------- -By participating in this project, you agree to abide by the -`Python Software Foundation Code of Conduct `_. -Please read it to understand the expectations for behavior when contributing to this project. +By participating in this project, you agree to abide by the +`Python Software Foundation Code of Conduct `_. +Please read it to understand the expectations for behaviour when contributing to this project. Coding Style Guide ------------------ @@ -26,6 +26,7 @@ Before committing Python changes, run: ruff format . ruff check . + typos . .. _code: @@ -39,30 +40,30 @@ When contributing code please follow these steps: 3. Create tests that demonstrate your bug or feature. 4. Make changes, ensuring the coding style guide is followed. 5. Run all tests again including one added and ensure all tests pass. -6. Send a Github Pull Request to the repository's **master** branch +6. Send a GitHub Pull Request to the repository's **master** branch -Our project maintainers have the last word on if contributions are suitable or not. If your contribution is rejected dont despair! -Following the guidlines above will give you the best chance of getting accpeted. +Our project maintainers have the last word on if contributions are suitable or not. If your contribution is rejected don't despair! +Following the guidelines above will give you the best chance of getting accepted. Documentation Contributions --------------------------- -Documentation imporvements are always welcome! We understand that good documentation is important for all users of a package. -The documentation files can be found in the docs/ folder. They are written in `reStructedText `_, +Documentation improvements are always welcome! We understand that good documentation is important for all users of a package. +The documentation files can be found in the docs/ folder. They are written in `reStructuredText `_, and use `Sphinx `_ to generate the documentation. -When contributing documentation please follow the style of current documentation, having a semi-formal yet friendly approach. -Ensure any code in documentation is well commeneted to ensure parameters are well understood. +When contributing documentation please follow the style of current documentation, having a semi-formal yet friendly approach. +Ensure any code in documentation is well commented to ensure parameters are well understood. Bug Reports ------------ -We welcome all bug reports! Before you raise one though please check the `GitHub issues `_, -both open and closed, to confirm the bug hastn been reported before. If you do submit a bug report ensure that the bug is clearly described, +We welcome all bug reports! Before you raise one though please check the `GitHub issues `_, +both open and closed, to confirm the bug hasn't been reported before. If you do submit a bug report ensure that the bug is clearly described, giving the situation that caused the bug and some repeatable code for testing. Feature Requests ---------------- -If you believe a feature is missing, feel free to raise a feature request. Keep in mind that being an open source project requested features may +If you believe a feature is missing, feel free to raise a feature request. Keep in mind that being an open source project requested features may or may not be implemented. If there is a feature you really need consider creating it yourself and :ref:`submitting the code `. diff --git a/docs/features/angles.rst b/docs/features/angles.rst index 101b179..d229e85 100644 --- a/docs/features/angles.rst +++ b/docs/features/angles.rst @@ -70,7 +70,7 @@ All **angle classes** can be seen below: .. autoclass:: geodepy.angles.DDMAngle :members: -.. _converstions: +.. _conversions: ------------------- @@ -132,7 +132,7 @@ For converting **Gradians** to other formats: ------------------- -Other Converstion Functions: +Other Conversion Functions: .. autofunction:: geodepy.angles.dd2sec diff --git a/docs/features/constants.rst b/docs/features/constants.rst index 8eda509..6064b0f 100644 --- a/docs/features/constants.rst +++ b/docs/features/constants.rst @@ -8,7 +8,7 @@ This module contains constants commonly used in geodetic calculations, including Classes -------- -GeodePy provides four classes for handling commonly used geodetic constants. These include a class for ellipsoids, projections, tranformations and tranformations sigmas. +GeodePy provides four classes for handling commonly used geodetic constants. These include a class for ellipsoids, projections, transformations and transformations sigmas. These classes can be used to create objects that store the relevant parameters for each type of constant, and provide methods for accessing and manipulating these parameters. @@ -164,11 +164,11 @@ All other combinations of ITRF transformations are available. IERS to GeodePy Transformation ------------------------------ -GeeodePy also includes a function for converting from IERS transfomration parameters to a GeodePy Transformation object. +GeeodePy also includes a function for converting from IERS transformation parameters to a GeodePy Transformation object. .. autofunction:: geodepy.constants.iers2trans Height --------- -The module also contains locations for files commonly used in height converstions that will be used in the :ref:`height ` module. \ No newline at end of file +The module also contains locations for files commonly used in height conversions that will be used in the :ref:`height ` module. diff --git a/docs/features/geodesy.rst b/docs/features/geodesy.rst index b37aa29..84fa63f 100644 --- a/docs/features/geodesy.rst +++ b/docs/features/geodesy.rst @@ -5,7 +5,7 @@ Geodesy This module includes functions for geodetic calculations. -Convertions +Conversions ------------ .. autofunction:: geodepy.geodesy.enu2xyz diff --git a/docs/features/height.rst b/docs/features/height.rst index a7887e7..435d9d8 100644 --- a/docs/features/height.rst +++ b/docs/features/height.rst @@ -38,7 +38,7 @@ The functions below can be used to calculate different components of gravity. .. autofunction:: geodepy.height.normal_correction .. autofunction:: geodepy.height.normal_orthometric_correction -Auxilary Function +Auxiliary Function ----------------- Functions used to enable other functions in the module. diff --git a/docs/features/ntv2reader.rst b/docs/features/ntv2reader.rst index 5caae8c..8e5cfa8 100644 --- a/docs/features/ntv2reader.rst +++ b/docs/features/ntv2reader.rst @@ -3,7 +3,7 @@ NTV2 Reader =============== -Tihs module provides functionality to read and utilize NTV2 grid files for coordinate transformations. +This module provides functionality to read and utilize NTV2 grid files for coordinate transformations. It has been adapted from Jaimie Dodd's ntv2reader.py Classes diff --git a/docs/tutorials/anglestut.rst b/docs/tutorials/anglestut.rst index 2bf80af..7ba7705 100644 --- a/docs/tutorials/anglestut.rst +++ b/docs/tutorials/anglestut.rst @@ -1,6 +1,6 @@ .. _tutorials/angles: -Angle Classes and Converstions +Angle Classes and Conversions ================================= GeodePy has 5 main angle classes to represent angles in different formats. These will be explored here along with how to convert between these types. @@ -26,7 +26,7 @@ Angles expressed in degrees, minutes, and seconds. - **Conversion:** 1° = 60′, 1′ = 60″ - **Example:** ``123° 34' 56.2"`` -To initalise a dms class: +To initialise a dms class: .. code:: python @@ -41,7 +41,7 @@ Angles expressed in degrees and minutes, with minutes shown as a decimal fractio - **Format:** ``ddd° mm.mm'`` - **Example:** ``123° 34.933'`` -To initalise a ddm class: +To initialise a ddm class: .. code:: python @@ -56,7 +56,7 @@ Angles expressed entirely in decimal degrees. - **Format:** ``ddd.ddd°`` - **Example:** ``123.5823°`` -To initalise a dec class: +To initialise a dec class: .. code:: python @@ -71,7 +71,7 @@ HP notation expresses latitude and longitude as positive values with hemisphere - **Format:** ``ddd.mmssss`` - **Example:** ``123.231524°`` -To initalise a hpa class: +To initialise a hpa class: .. code:: python @@ -87,7 +87,7 @@ A metric-based angle unit where a full circle equals 400 gradians. - **Conversion:** 1 grad = 0.9° - **Example:** ``137.5`` -To initalise a gona class: +To initialise a gona class: .. code:: python @@ -106,7 +106,7 @@ First import GeodePy. import geodepy.angles as angles -In this example a DMS angle will be created. This object can be initalised by including the degrees, minutes and seconds as arguments. +In this example a DMS angle will be created. This object can be initialised by including the degrees, minutes and seconds as arguments. .. code:: python @@ -115,7 +115,7 @@ In this example a DMS angle will be created. This object can be initalised by in >>30 5 42 -Using this class we can get individual variables for degree minute and seconds componets seperately. +Using this class we can get individual variables for degree minute and seconds components separately. .. code:: python @@ -152,7 +152,7 @@ This will be done using the DDM Angle class angle2 = angles.DDMAngle(40, 10.52) -Now this new anlge class can be added or subtracted from the first class +Now this new angle class can be added or subtracted from the first class .. code:: python @@ -201,4 +201,3 @@ The following operators can be preformed on angle objects: +----------------------+------------------+ .. caution:: Basic arthimitc should not be completed on HPA class. These should be converted to decimal degree first. - diff --git a/docs/tutorials/coordtut.rst b/docs/tutorials/coordtut.rst index 59288b0..b9338cb 100644 --- a/docs/tutorials/coordtut.rst +++ b/docs/tutorials/coordtut.rst @@ -11,7 +11,7 @@ The three different classes are: - :ref:`CoordGeo - Geographic Coordinates (lat, long, H) ` - :ref:`CoordTM - Transverse Mercator Coordinates (e, n, H) ` -To learn more about these corrdinate types refer to the `GDA2020 technical manual `_. +To learn more about these coordinate types refer to the `GDA2020 technical manual `_. Classes -------- @@ -21,13 +21,13 @@ Classes Cartesian Coordinates ^^^^^^^^^^^^^^^^^^^^^^ Cartesian coordinates represent points in three dimensions (X, Y, Z), typically in an Earth-Centered, Earth-Fixed (ECEF) system. -In this class an "n" value can also be added representing seperation between ellipsoid and geiod. +In this class an "n" value can also be added representing separation between ellipsoid and geiod. - **Description:** Defines a point by its distance along three perpendicular axes. - **Format:** ``(X, Y, Z)`` in meters. - **Example:** ``( -4052051.0, 4212831.0, -2545100.0 )`` -To initalise a cartesian coordinate class: +To initialise a cartesian coordinate class: .. code:: python @@ -43,7 +43,7 @@ Geographic coordinates express positions on the Earth's surface using latitude, - **Format:** ``(latitude, longitude, height)`` - **Example:** ``(-33.8650°, 151.2094°, 58)`` -To initalise a geographic coordinate class: +To initialise a geographic coordinate class: .. code:: python @@ -59,7 +59,7 @@ A projected coordinate system that maps the curved Earth onto a flat plane using - **Format:** ``(Zone, Easting, Northing, Height)`` - **Example:** ``(55, 334567.89, 6254321.12, 58.2)`` -To initalise a transverse mercator coordinate class: +To initialise a transverse mercator coordinate class: .. code:: python @@ -78,7 +78,7 @@ First import GeodePy. import geodepy.coord import geodepy.geodesy -We can now create a coordinate obect. For this example we will use a transverse mercator coordinate. +We can now create a coordinate object. For this example we will use a transverse mercator coordinate. .. code:: python diff --git a/docs/tutorials/juypter notebooks/GeodePy Tutorial - EDM Corrections.ipynb b/docs/tutorials/juypter notebooks/GeodePy Tutorial - EDM Corrections.ipynb index 5f8862f..2fc4014 100644 --- a/docs/tutorials/juypter notebooks/GeodePy Tutorial - EDM Corrections.ipynb +++ b/docs/tutorials/juypter notebooks/GeodePy Tutorial - EDM Corrections.ipynb @@ -6,7 +6,7 @@ "source": [ "# EDM Corrections\n", "\n", - "Tihs tutorial shows how to compute first velocity parameters, apply first velocity corrections (with and without CO₂), and reduce a measured distance to horizontal using GeodePy." + "This tutorial shows how to compute first velocity parameters, apply first velocity corrections (with and without CO₂), and reduce a measured distance to horizontal using GeodePy." ] }, { @@ -31,7 +31,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "First the variables need to be defined. Below is some example paramters for the Lecia Viva." + "First the variables need to be defined. Below is some example parameters for the Lecia Viva." ] }, { @@ -124,7 +124,7 @@ "source": [ "## Horizontal Distance\n", "\n", - "Now the horizontal distacne can be found using the zenith angle and corrected distance." + "Now the horizontal distance can be found using the zenith angle and corrected distance." ] }, { diff --git a/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Angular Notation Formats.ipynb b/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Angular Notation Formats.ipynb index bc9ca8c..d4b4972 100644 --- a/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Angular Notation Formats.ipynb +++ b/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Angular Notation Formats.ipynb @@ -6,7 +6,7 @@ "collapsed": true }, "source": [ - "## Geodepy Tutorial: Angular Notation Formats\n", + "## GeodePy Tutorial: Angular Notation Formats\n", "\n", "This tutorial demonstrates GeodePy's system of functions and classes for handling angular notation. At the time of writing, Wikipedia lists 10 different units used to represent angles. This is too many, so GeodePy handles four (4) different kinds of notation commonly used in geodesy and surveying and this tutorial will show you how to convert between these. The four kinds of notation *(and their shorthand in code)* in GeodePy are:\n", "\n", diff --git a/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Time-Dependent Datum Transformations.ipynb b/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Time-Dependent Datum Transformations.ipynb index 3585bf5..513d624 100644 --- a/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Time-Dependent Datum Transformations.ipynb +++ b/docs/tutorials/juypter notebooks/ss/GeodePy Tutorial - Time-Dependent Datum Transformations.ipynb @@ -4,9 +4,9 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "## Geodepy Tutorial: Time-Dependent Datum Transformations\n", + "## GeodePy Tutorial: Time-Dependent Datum Transformations\n", "\n", - "This tutorial demonstrates the use of GeodePy for transformations between time-dependent dynamic datums. We'll work through each of the steps required to tranform a coordinate in ITRF2005 at epoch 2000.0 to ITRF2014 at 2020.0 on the Australian Plate, then build a function containing these steps to simplify this process." + "This tutorial demonstrates the use of GeodePy for transformations between time-dependent dynamic datums. We'll work through each of the steps required to transform a coordinate in ITRF2005 at epoch 2000.0 to ITRF2014 at 2020.0 on the Australian Plate, then build a function containing these steps to simplify this process." ] }, { @@ -169,7 +169,7 @@ "source": [ "This gives us Bob's Cartesian Coordinates in ITRF2014 at epoch 2010.0.\n", "#### Part 4: Moving to the Final Epoch\n", - "The final tranformation is moving Bob's epoch to it's final destination (2020.0) using `itrf2014_to_gda2020`. As the period of movement (2010.0 to 2020.0) is the same (+10.0 years), we use the same `to_epoch` of 2030.0 as in Part 2:" + "The final transformation is moving Bob's epoch to it's final destination (2020.0) using `itrf2014_to_gda2020`. As the period of movement (2010.0 to 2020.0) is the same (+10.0 years), we use the same `to_epoch` of 2030.0 as in Part 2:" ] }, { diff --git a/docs/tutorials/sinextut.rst b/docs/tutorials/sinextut.rst index 50cc10e..d0df642 100644 --- a/docs/tutorials/sinextut.rst +++ b/docs/tutorials/sinextut.rst @@ -3,7 +3,7 @@ Sinex Files ============ -Geodepy has the ability to read and write sinex files. Below we will explore how to +GeodePy has the ability to read and write SINEX files. Below we will explore how to read certain parts of a sinex file and ultimately how to write a new sinex file. In this tutorial the sinex file "STR1AUSPOS.SNX" found in the docs folder will be used. This was generated using AUSPOS. diff --git a/docs/tutorials/timedeptranstut.rst b/docs/tutorials/timedeptranstut.rst index 522c8ff..b7a0874 100644 --- a/docs/tutorials/timedeptranstut.rst +++ b/docs/tutorials/timedeptranstut.rst @@ -1,13 +1,13 @@ .. _tutorials/timetrans: -Time Dependant Transformations +Time Dependent Transformations ============================== -In this tutorial we will discuss time dependant transformations. -To see transformations between static datums view the :ref:`datum transformation ` tutorial. -To learn more about time dependant transformations refer to the `GDA2020 technical manual `_. +In this tutorial we will discuss time dependent transformations. +To see transformations between static datums view the :ref:`datum transformation ` tutorial. +To learn more about time dependent transformations refer to the `GDA2020 technical manual `_. -Time dependant transformation are much more complex then transformation between static datums. First we will complete a simply example. +Time dependent transformations are much more complex than transformations between static datums. First we will complete a simple example. Common Example -------------- @@ -20,7 +20,7 @@ First we will import geodepy. .. code:: python - import geodepy.tranform + import geodepy.transform from datetime import date Now the function for transforming from ATRF2014 to GDA2020 can be used. @@ -43,18 +43,18 @@ This is the GDA2020 coordinate. Transforming between Dynamic and Static Datums ---------------------------------------------- -The simpliest time dependant transformations go between static and dynamic datums. +The simplest time dependent transformations go between static and dynamic datums. Below we will complete such a transformation that doesn't include a dedicated function. Here we will transform from GDA94 to ITRF2008 at 1/1/2007. .. code:: python - import geodepy.tranform + import geodepy.transform import geodepy.constants from datetime import date -To go from GDA94 to ITRF2008 we need to investigate what transformations are present in GeodePy. This can be found +To go from GDA94 to ITRF2008 we need to investigate what transformations are present in GeodePy. This can be found in :ref:`this ` table. Here we can see that there is a direct transformation from GDA94 to ITRF2008. We will use this to complete our transformation. @@ -77,7 +77,7 @@ This is the ITRF2008 coordinate on 1/1/2007 Transforming Between Two Dynamic Datums --------------------------------------- -Transforming between two dynamic datums is more complex, requiring a few more steps and considerations. +Transforming between two dynamic datums is more complex, requiring a few more steps and considerations. For this example we will transform from ITRF2008 at 1/1/2007 to ITRF2020 at 1/1/2030. .. code:: python @@ -85,10 +85,10 @@ For this example we will transform from ITRF2008 at 1/1/2007 to ITRF2020 at 1/1/ import geodepy.constant import geodepy.transform -First the ITRF2008 coordinates need to be converted to ITRF2014. This is completed so that the plate motion -between 2007 and 2030 can be applied. The plate motion can only be applied to coordinates in ITRF2014 or -ATRF2014. When completeing this transformation the date of the ITRF2008 epoch is entered. This means the -resulting ITRF2020 cooridnate will be at the IRTF2008 epoch. +First the ITRF2008 coordinates need to be converted to ITRF2014. This is completed so that the plate motion +between 2007 and 2030 can be applied. The plate motion can only be applied to coordinates in ITRF2014 or +ATRF2014. When completing this transformation the date of the ITRF2008 epoch is entered. This means the +resulting ITRF2020 coordinate will be at the IRTF2008 epoch. .. code:: python @@ -104,11 +104,11 @@ resulting ITRF2020 cooridnate will be at the IRTF2008 epoch. >>-4050762.614575 4220880.820347 -2533400.419192 -Now we have an ITRF2014 coordinate at 1/1/2007. Now this needs to be moved to the 1/1/2030. This can be -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. +Now we have an ITRF2014 coordinate at 1/1/2007. Now this needs to be moved to the 1/1/2030. This can be +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. -The plate_motion_transformation function can be used to move coordinates in time. This avoids the need to +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:: @@ -118,43 +118,43 @@ calculate the difference between the reference epoch and the epoch required. Thi .. code:: python x, y, z, vcv = geodepy.transform.plate_motion_transformation( - x, - y, + x, + y, z, date(2007, 1, 1), #from epoch date(2030, 1, 1), #to epoch - geodepy.constants.itrf2014_to_gda2020 #transformation paramters + geodepy.constants.itrf2014_to_gda2020 #transformation parameters ) print(x, y, z) >>-4050763.517081 4220880.699892 -2533399.176829 -This is now the ITRF2014 corrdinate at 1/1/2030. Now we can convert this ITRF2014 coordinate to ITRF2020. +This is now the ITRF2014 coordinate at 1/1/2030. Now we can convert this ITRF2014 coordinate to ITRF2020. .. code:: python x, y, z, vcv = geodepy.transform.conform14( - x, - y, - z, + x, + y, + z, date(2030,1,1), #ITRF2014 epoch - geodepy.constants.itrf2014_to_itrf2020 #transformation paramter + geodepy.constants.itrf2014_to_itrf2020 #transformation parameter ) print(x, y, z) >>-4050763.517382 4220880.704065 -2533399.182293 -This is the final cooridnate in ITRF2020 at 1/1/2030. +This is the final coordinate in ITRF2020 at 1/1/2030. .. _tutorials/transold: Transforming Between Older Dynamic Datums ----------------------------------------- -The Australia plate motion model should only be used between the years of 2005 to 2035. If a datum older then -this needs to be transformed a different method should be used. For this example we will tranform from ITRF88 +The Australia plate motion model should only be used between the years of 2005 to 2035. If a datum older then +this needs to be transformed a different method should be used. For this example we will transform from ITRF88 at 1/1/1988 to ITRF2014 at 1/1/2030. .. caution:: This method only works for coordinates within Australia. @@ -187,9 +187,9 @@ This is the ITRF2014 coordinate at 1/1/1988. Now this needs to be transformed in .. code:: python x, y, z, vcv = geodepy.transform.conform14( - x, - y, - z, + x, + y, + z, date(1988,1,1), #ITRF2014 epoch geodepy.constants.itrf2014_to_gda2020 #transformation parameters ) @@ -203,9 +203,9 @@ Now this corrinate can be changed to ITRF2014 at 1/1/2030. .. code:: python x, y, z, vcv = geodepy.transform.conform14( - x, - y, - z, + x, + y, + z, date(2030,1,1), #ITRF2020 epoch geodepy.constants.gda2020_to_itrf2014 #transformation parameters ) @@ -214,4 +214,4 @@ Now this corrinate can be changed to ITRF2014 at 1/1/2030. >>-4050764.764547 4220880.480531 -2533397.346309 -This is now the ITRF2014 coordinate at 1/1/2030. \ No newline at end of file +This is now the ITRF2014 coordinate at 1/1/2030. diff --git a/docs/tutorials/transformtut.rst b/docs/tutorials/transformtut.rst index 88ba5fb..5022e1b 100644 --- a/docs/tutorials/transformtut.rst +++ b/docs/tutorials/transformtut.rst @@ -3,25 +3,25 @@ Datum Transformation ===================== -GeodePy has the ability to tranform between datums. Here we will discuss how to -change between datums without changing the reference epoch while in the -:ref:`time dependant ` tutorial we will discuss changing epochs. +GeodePy has the ability to transform between datums. Here we will discuss how to +change between datums without changing the reference epoch while in the +:ref:`time dependent ` tutorial we will discuss changing epochs. To learn more about transformation refer to the `GDA2020 technical manual `_. Common Example -------------- -The most common example for datum transformation is converting from MGA94 to MGA2020. -This is handled by a function in the transformation module that converts the grid -input to a caresian coordinate (xyz), and then runs a 7 paramter helmert transformation -using the gda94_to_gda2020 transformation constant. This process will be explored more in +The most common example for datum transformation is converting from MGA94 to MGA2020. +This is handled by a function in the transformation module that converts the grid +input to a cartesian coordinate (xyz), and then runs a 7 parameter helmert transformation +using the gda94_to_gda2020 transformation constant. This process will be explored more in the :ref:`latter ` part of this tutorial but first lets use this function. Begin by importing GeodePy. .. code:: python - import geodepy.transform + import geodepy.transform Next, define some coordinate values in MGA94. @@ -47,8 +47,8 @@ Now, transform this coordinate to MGA2020. This it the MGA2020 coordinates. -To complete this transformation a function from the transformation module was used. This -will not always be the case. In the next section transformations where a function is not already +To complete this transformation a function from the transformation module was used. This +will not always be the case. In the next section transformations where a function is not already present will be explored. .. _tutorials/transformfunc: @@ -63,7 +63,7 @@ First import GeodePy. .. code:: python - import geodepy.transform + import geodepy.transform import geodepy.constants import geodepy.angles @@ -73,13 +73,13 @@ Now we need some starting coordinates. lat = geodepy.angles.DMSAngle(-23,33,25.21) long = geodepy.angles.DMSAngle(133,49,13.87) - height = 427.863 + height = 427.863 print(f"The AGD84 position is {lat}, {long}, {height}" >>The AGD84 position is -23 33 25.21, 133 49 13.87, 427.863 -All transformations in GeodePy need to be completed with corrdinates in cartesian (xyz) form. Lets transform to xyz. +All transformations in GeodePy need to be completed with coordinates in cartesian (xyz) form. Let's transform to xyz. .. code:: python @@ -88,9 +88,9 @@ All transformations in GeodePy need to be completed with corrdinates in cartesia >>-4050634.051819 4220935.13646 -2533555.369303 -Now we need some transformation parameters. Within Geodepy there are many transformaton parameters already -present within the constants module. A table of these can be seen :ref:`here `. If the -transformation needed isn't currently in Geodepy, new transformations can be added using the :ref:`transformation class `. +Now we need some transformation parameters. Within GeodePy there are many transformation parameters already +present within the constants module. A table of these can be seen :ref:`here `. If the +transformation needed isn't currently in GeodePy, new transformations can be added using the :ref:`transformation class `. Here the agd66_to_gda94 transformation will be used. .. code:: python @@ -107,35 +107,35 @@ Here the agd66_to_gda94 transformation will be used. >>ry: -0.443" + 0.0"/yr >>rz: -0.277" + 0.0"/yr -These transformation parameters will be used to complete a 7 paramter helmert transformation. +These transformation parameters will be used to complete a 7 parameter helmert transformation. .. code:: python x_94, y_94, z_94, _ = geodepy.transform.conform7( - x, - y, - z, + x, + y, + z, geodepy.constants.agd84_to_gda94 #transformation parameters ) print(x_94, y_94, z_94) >>-4050762.150962 4220880.96717 -2533401.14935 -.. tip:: - The "_" in the conform7 variables is for a vcv matrix. If you dont input a vcv matrix - then the resulting variable will be None. However as the variable needs to be assigned - for the function to work using "_" meets to requirement but doesn't store the variable +.. tip:: + The "_" in the conform7 variables is for a vcv matrix. If you don't input a vcv matrix + then the resulting variable will be None. However as the variable needs to be assigned + for the function to work using "_" meets to requirement but doesn't store the variable in a meaningful way. -Now we need to transform from GDA94 to GDA2020 using the same method but with the gda94_to_gda2020 +Now we need to transform from GDA94 to GDA2020 using the same method but with the gda94_to_gda2020 transformation class. .. code:: python x_20, y_20, z_20, _ = geodepy.transform.conform7( - x_94, - y_94, - z_94, + x_94, + y_94, + z_94, geodepy.constants.gda94_to_gda2020 #transformation parameters ) @@ -149,9 +149,9 @@ Now the cartesian coordinates can be converted back to geographic coordinates (l lat_20, long_20, height_20 = geodepy.transform.xyz2llh(x_20, y_20, z_20) - print(f"The GDA2020 position is - {geodepy.angles.dec2dms(lat_20)}, - {geodepy.angles.dec2dms(long_20)}, + print(f"The GDA2020 position is + {geodepy.angles.dec2dms(lat_20)}, + {geodepy.angles.dec2dms(long_20)}, {height_20}") >>The GDA2020 position is -23 33 19.921108332, 133 49 18.481110119, 411.61055134 @@ -164,11 +164,11 @@ All of this can now be combined into one function. x, y, z = geodepy.transform.llh2xyz(lat, long, height) x_94, y_94, z_94, _ = geodepy.transform.conform7( - x, y, z, + x, y, z, geodepy.constants.agd84_to_gda94 ) x_20, y_20, z_20, _ = geodepy.transform.conform7( - x_94, y_94, z_94, + x_94, y_94, z_94, geodepy.constants.gda94_to_gda2020 ) @@ -176,10 +176,9 @@ All of this can now be combined into one function. lat_new, long_new, height_new = transform_agd84_to_gda2020(lat, long, height) - print(f"The GDA2020 position is - {geodepy.angles.dec2dms(lat_new)}, - {geodepy.angles.dec2dms(long_new)}, + print(f"The GDA2020 position is + {geodepy.angles.dec2dms(lat_new)}, + {geodepy.angles.dec2dms(long_new)}, {height_new}") >>The GDA2020 position is -23 33 19.921108332, 133 49 18.481110119, 411.61055134 - diff --git a/geodepy/constants.py b/geodepy/constants.py index b504ec4..a9e99da 100644 --- a/geodepy/constants.py +++ b/geodepy/constants.py @@ -2239,7 +2239,7 @@ class parameters. itrf89_to_itrf2000 = -itrf2000_to_itrf89 itrf88_to_itrf2000 = -itrf2000_to_itrf88 -# ITRF97 paramters +# ITRF97 parameters # Ref: https://itrf.ign.fr/en/solutions/transformations itrf97_to_itrf96 = iers2trans( @@ -2692,7 +2692,7 @@ class parameters. itrf89_to_itrf94 = -itrf94_to_itrf89 itrf88_to_itrf94 = -itrf94_to_itrf88 -# ITRF93 paramters +# ITRF93 parameters # Ref: https://itrf.ign.fr/en/solutions/transformations itrf93_to_itrf92 = iers2trans( @@ -2801,7 +2801,7 @@ class parameters. itrf89_to_itrf93 = -itrf93_to_itrf89 itrf88_to_itrf93 = -itrf93_to_itrf88 -# ITRF92 paramters +# ITRF92 parameters # Ref: https://itrf.ign.fr/en/solutions/transformations itrf92_to_itrf91 = iers2trans( @@ -3002,7 +3002,7 @@ class parameters. itrf89_to_itrf90 = -itrf90_to_itrf89 itrf88_to_itrf90 = -itrf90_to_itrf88 -# ITRF89 Paramters +# ITRF89 Parameters # Ref: https://itrf.ign.fr/en/solutions/transformations itrf89_to_itrf88 = iers2trans( @@ -3148,7 +3148,7 @@ class parameters. wgs84g2296_to_wgs84g2139 = -wgs84g2139_to_wgs84g2296 wgs84g2296_to_wgs84g1762 = -wgs84g1762_to_wgs84g2296 -# WGS84 (G2139) paramters +# WGS84 (G2139) parameters # https://www.unoosa.org/documents/pdf/icg/2023/ICG-17/icg17_wgd_02_02.pdf wgs84g2139_to_itrf2014_sd = TransformationSD( diff --git a/geodepy/convert.py b/geodepy/convert.py index 23b89d6..b123986 100644 --- a/geodepy/convert.py +++ b/geodepy/convert.py @@ -47,7 +47,7 @@ def polar2rect(r, theta): Converts point in polar coordinates to corresponding rectangular coordinates :param r: Radius - :param theta: Angle (decimal degrees) from postive y axis (north) + :param theta: Angle (decimal degrees) from positive y axis (north) :type theta: Float (decimal degrees), DMSAngle or DDMAngle :return: Rectangular Coordinates X, Y diff --git a/geodepy/geodesy.py b/geodepy/geodesy.py index 0c0102d..b6609f3 100644 --- a/geodepy/geodesy.py +++ b/geodepy/geodesy.py @@ -482,7 +482,7 @@ def line_sf( east2 = stn2_zone1[2] north2 = stn2_zone1[3] - # Comute easting distances from Central Meridian + # Compute easting distances from Central Meridian eastofcm1 = east1 - projection.falseeast eastofcm2 = east2 - projection.falseeast diff --git a/geodepy/gnss.py b/geodepy/gnss.py index 2c5f703..2dc66ce 100644 --- a/geodepy/gnss.py +++ b/geodepy/gnss.py @@ -118,7 +118,7 @@ def read_sinex_comments(file): comments.insert( -1, - f"* File created by Geodepy.gnss.py at {datetime.now().strftime('%d-%m-%Y, %H:%M')}", + f"* File created by GeodePy.gnss.py at {datetime.now().strftime('%d-%m-%Y, %H:%M')}", ) return comments @@ -449,7 +449,7 @@ def read_sinex_sites(file): * point is the site's point code * domes is the site's dome number * obs is the observation technique - * station_description is a free format desciption of the site + * station_description is a free format description of the site * lon is the approximate longitude of the site as a DMSAngle object * lat is the approximate latitude of the site as a DMSAngle object * h is the approximate height of the site @@ -1230,7 +1230,7 @@ def dataframe2matrix_solution_matrix_estimate(df, tri="L"): forms the full VCV matrix from that dataframe. :param DataFrame df: dataframe from sinex2dataframe_solution_matrix_estimate(). - :param String tri: String to indicate "upper" or "lower" triagle matrix. + :param String tri: String to indicate "upper" or "lower" triangle matrix. :return: Numpy matrix of full VCV. """ @@ -1312,7 +1312,7 @@ def matrix2dataframe_solution_matrix_estimate(m, tri="L"): is the format produced from sinex2dataframe_solution_matrix_estimate(). :param numpy.array() m: A numpy array of the VCV matrix. - :param str tri: String to indicate "upper" or "lower" triagle matrix. + :param str tri: String to indicate "upper" or "lower" triangle matrix. :return: A dataframe of SOLUTION/MATRIX_ESTIMATE. :rtype: DataFrame """ @@ -1464,7 +1464,7 @@ def writeSINEX( :param list of str SiteID: +SITE/ID block. Can get from read_sinex_site_id_block(). :param list of str SolutionEpochs: +SOLUTION/EPOCHS block. Can get from read_sinex_solution_epochs_block(). :param list of str SolutionEstimate: +SOLUTION/ESTIMATE block. Can get from read_sinex_solution_estimate_block(). - :param list of str SolutionMatricEstimate: +SOLUTION/MATRIX_ESTIMATE block. Can get from read_sinex_solution_matrix_estimate_block(). + :param list of str SolutionMatrixEstimate: +SOLUTION/MATRIX_ESTIMATE block. Can get from read_sinex_solution_matrix_estimate_block(). :param list of str fileReference: +FILE/REFERENCE block. Can get from read_sinex_file_reference_block(). :param list of str inputAcknowledgments: +INPUT/ACKNOWLEDGEMENTS block. Can get from read_sinex_input_acknowledgments_block(). :param list of str siteReceiver: +SITE/RECEIVER block. Can get from read_sinex_site_receiver_block(). @@ -1472,7 +1472,7 @@ def writeSINEX( :param list of str siteGpsPhaseCenter: +SITE/GPS_PHASE_CENTER block. Can get from read_site_gps_phase_center_block(). :param list of str siteEccentricity: +SITE/ECCENTRICITY block. Can get from read_sinex_site_eccentricity_block(). :param list of str solutionApriori: +SOLUTION/APRIORI block. Can get from read_sinex_solution_apriori_block(). - :param list of str solutionMatrixApriori: +SOLUTION/MATRIX_APRIORI block. Can get from read_sinex_solution_matric_apriori_block(). + :param list of str solutionMatrixApriori: +SOLUTION/MATRIX_APRIORI block. Can get from read_sinex_solution_matrix_apriori_block(). :return: No return. But a new SINEX file will be written out to the file path (fp). diff --git a/geodepy/height.py b/geodepy/height.py index 9bb8af4..9f36f88 100644 --- a/geodepy/height.py +++ b/geodepy/height.py @@ -1,7 +1,7 @@ # ___________________________________________________________________________# # Some notes: # Written by Jack McCubbine of Geoscience Australia, date: 08/11/2019 -# This code contains functions to handle tranformations between GPS and +# This code contains functions to handle transformations between GPS and # AWVS/AHD and Vice Versa # Gridded data used for the varisous reference surfaces are geotiff files # These allow direct access remotely using "gdal" diff --git a/geodepy/survey.py b/geodepy/survey.py index 33b95c9..bc8484f 100644 --- a/geodepy/survey.py +++ b/geodepy/survey.py @@ -321,7 +321,7 @@ def va_conv(zenith_angle, slope_dist, height_inst=0, height_tgt=0): SIGMA = wavenumber (1/micrometre) SVP = saturation vapour pressure of water vapour (Pa) in air at temperature (TK) - TC = temperature (degrees Celcius) + TC = temperature (degrees Celsius) TK = temperature (Kelvin) W0,W1,W2,W3 = constants used to calculate NWS XC = carbon dioxide content (ppm) @@ -336,7 +336,7 @@ def refractivity_constants(): """ :return: Refractivity constants used in the refractivity calculations. """ - # PECK & REEDER (1972) AS AMMENDED BY CIDDOR + # PECK & REEDER (1972) AS AMENDED BY CIDDOR # (DRY AIR REFRACTIVITY) (K0, K1, K2, K3) = (238.0185, 5792105.0, 57.362, 167917.0) @@ -382,7 +382,7 @@ def phase_refractivity(LAMDA, TC, P, PV, XC=420): Calculates the phase refractivity of moist air using Ciddor's equations :param LAMDA: wavelength (micrometre) - :param TC: temperature (degrees Celcius) + :param TC: temperature (degrees Celsius) :param P: pressure (hPa) :param PV: partial water vapour pressure (Pa) :param XC: carbon dioxide content (ppm) @@ -516,7 +516,7 @@ def group_refractivity(LAMDA, TC, P, PV, XC=420): Calculates the group refractivity of moist air using Ciddor's equations :param LAMDA: wavelength (micrometre) - :param TC: temperature (degrees Celcius) + :param TC: temperature (degrees Celsius) :param P: pressure (hPa) :param PV: partial water vapour pressure (Pa) :param XC: carbon dioxide content (ppm) @@ -653,7 +653,7 @@ def humidity2part_water_vapour_press(H, TC): Calculates the partial water vapour pressure from relative humidity and temperature :param H: humidity (%) - :param TC: temperature (degrees Celcius) + :param TC: temperature (degrees Celsius) :return: PV - partial water vapour pressure (Pa) """ @@ -661,7 +661,7 @@ def humidity2part_water_vapour_press(H, TC): (A, B, C, D) = (1.2378847e-5, -1.9121316e-2, 33.93711047, -6.3431645e3) TK = TC + 273.15 - # NOW CONVERT THE RELATIVE HUMIDITY TO PATIAL WATER VAPOUR PRESSURE (hPa) + # NOW CONVERT THE RELATIVE HUMIDITY TO PARTIAL WATER VAPOUR PRESSURE (hPa) # SEE EQ.(22) GIACOMO 1982 SVP = exp(A * TK * TK + B * TK + C + D / TK) PV = (H / 100.0) * SVP