Fixed spelling mistakes and made tutorials clearer

Kyran-Cook · Kyran-Cook · commit cf3cf5f0d7c3 · 2025-12-02T01:56:24.000Z
diff --git a/docs/_templates/sidebar/extra.html b/docs/_templates/sidebar/extra.html
@@ -1,5 +1,5 @@
 <div class="sidebar-extra" style="text-align:left; margin-top:0px; margin-bottom:5px ;">
-    <p style="font-size:14px; margin-bottom:10px;">GeodePy is a package of tools for manipulating goespatial datasets using Python.</p>
+    <p style="font-size:14px; margin-bottom:10px;">GeodePy is a python package for precise geodetic and survey computations.</p>
     <a href="https://github.com/GeoscienceAustralia/GeodePy" target="_blank">
     <img src="https://img.shields.io/badge/GitHub-GeodePy-blue?logo=github" alt="GitHub Badge" />
     </a>
diff --git a/docs/community/contributing.rst b/docs/community/contributing.rst
@@ -1,11 +1,62 @@
 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 recieve.
 
 This document outlines some of the guidlines 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 <https://policies.python.org/python.org/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 <https://policies.python.org/python.org/code-of-conduct/>`_. 
+Please read it to understand the expectations for behavior when contributing to this project.
+
+Coding Style Guide
+------------------
+
+GeodePy uses `Black <https://github.com/psf/black>`_ to keep coding style consistent while still being accessable to all. 
+Black uses `PEP 8 <https://peps.python.org/pep-0008/>`_ coding style, an industry standard for python code. Before 
+any commits to GeodePy ensure Black has been used.
+
+.. _code:
+
+Code Contributions
+------------------
+
+When contributing code please follow these steps:
+
+1. Fork the repository on `GitHub <https://github.com/GeoscienceAustralia/GeodePy>`_.
+2. Run tests on current code to ensure it works on your system (See :ref:`Testing <testing>`)
+3. Create tests that demonstrate your bug or feature.
+4. Make changes, ensuring coding sytle guide is abided by.
+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
+
+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.
+
+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 <http://docutils.sourceforge.net/rst.html>`_, 
+and use `Sphinx <http://sphinx-doc.org/index.html>`_ 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.
+
+Bug Reports
+------------
+
+We welcome all bug reports! Before you raise one though please check the `GitHub issues <https://github.com/GeoscienceAustralia/GeodePy/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, 
+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 
+or may not be implemented. If there is a feature you really need consider creating it yourself and :ref:`submitting the code <code>`.
diff --git a/docs/features/angles.rst b/docs/features/angles.rst
@@ -32,7 +32,7 @@ GeodePy supports Angular Notation in 9 different formats
 
 Conversion between all formats is supported as shown below:
 
-* Radians to/from Decimal Degrees via builtin math.radians and math.degrees
+* Radians to/from Decimal Degrees via built in math.radians and math.degrees
 
 * Formats as floats to all other types via functions in the form abrv2abrv
   
diff --git a/docs/features/constants.rst b/docs/features/constants.rst
@@ -132,7 +132,7 @@ For :class:`~geodepy.constants.Transformation`:
 +-----------------------------+---------------------+-------------------------------------------------------------+
 
 
-All other combinations of ITRF transofmrations are available.
+All other combinations of ITRF transformations are available.
 
 IERS to GeodePy Transformation
 ------------------------------
diff --git a/docs/features/gnss.rst b/docs/features/gnss.rst
@@ -32,14 +32,6 @@ Reading Sinex Files
 .. autofunction:: geodepy.gnss.read_sinex_solution_matrix_estimate_block
 .. autofunction:: geodepy.gnss.read_sinex_solution_matrix_apriori_block
 
-Converting Sinex Data to DataFrames
-------------------------------------
-
-.. autofunction:: geodepy.gnss.matrix2dataframe_solution_matrix_estimate
-.. autofunction:: geodepy.gnss.sinex2dataframe_solution_estimate
-.. autofunction:: geodepy.gnss.sinex2dataframe_solution_apriori
-.. autofunction:: geodepy.gnss.sinex2dataframe_solution_matrix_estimate
-
 Writing Sinex Files
 --------------------
 
@@ -52,6 +44,14 @@ Writing Sinex Files
 .. autofunction:: geodepy.gnss.dataframe2sinex_solution_matrix_estimate
 .. autofunction:: geodepy.gnss.writeSINEX
 
+Converting Sinex Data to DataFrames
+------------------------------------
+
+.. autofunction:: geodepy.gnss.matrix2dataframe_solution_matrix_estimate
+.. autofunction:: geodepy.gnss.sinex2dataframe_solution_estimate
+.. autofunction:: geodepy.gnss.sinex2dataframe_solution_apriori
+.. autofunction:: geodepy.gnss.sinex2dataframe_solution_matrix_estimate
+
 Specific Sinex Functions
 --------------------------
 
diff --git a/docs/features/survey.rst b/docs/features/survey.rst
@@ -3,7 +3,7 @@
 Surveying Calculations
 =======================
 
-This module provides various surveying calculation functions commonly used in geodetic and surveying applications.
+This module provides various surveying calculation commonly used in geodetic and surveying applications.
 
 EDM Corrections
 -----------------
diff --git a/docs/index.rst b/docs/index.rst
@@ -19,7 +19,7 @@ Release v0.6.0
     :target: https://www.anzlic.gov.au/ICSM
     :alt: Paper Badge
 
-**GeodePy** is a package of tools for manipulating geospatial datasets using Python.
+**GeodePy** is a python package for precise geodetic and survey computations.
 
 -------------------
 
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -7,7 +7,7 @@ This section contains instructions for installing GeodePy.
 
 Installing via pip
 --------------------
-The recommended way to install GeodePy is via pip. You can do this by running the following command in your terminal:
+The recommended way to install GeodePy is via pip. You can do this by running the following command in terminal:
 
 .. code:: bash
     
@@ -16,18 +16,49 @@ The recommended way to install GeodePy is via pip. You can do this by running th
 
 Installing from source
 ----------------------
-If you prefer to install GeodePy from source, you can clone the repository from GitHub and install it manually. Here are the steps:
+If you prefer to install GeodePy from source, you can clone the repository from GitHub and use the python files:
 
 .. code:: bash
 
    git clone https://github.com/GeoscienceAustralia/GeodePy.git
 
 .. _updating:
 
+Requirements
+------------
+
+GeodePy has some requirements that also need to be installed. Not all packages will be used for all modules.
+The requirements can be seen below.
+
+.. code::
+
+    NumPy
+    SciPy
+    GDAL #only needed for height 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.
+
 Updating GeodePy
 -----------------
-To update GeodePy to the latest version, you can use pip with the --upgrade flag:
+To update GeodePy to the latest version, you can use pip with the upgrade flag:
 
 .. code:: bash
 
-    pip install --upgrade geodepy   
+    pip install --upgrade geodepy  
+
+.. _testing:
+
+Testing GeodePy
+----------------- 
+
+GeodePy can be tested using the a unit test. This can be run as seen below.
+
+.. caution:: The directory may need to be changed to point to the correct test folder
+
+.. code:: python
+
+    python3 -m unittest discover GeodePy/geodepy/tests --verbose
+
+All tests should complete successfully. If not you may need to install some required 
+packages.
diff --git a/docs/tutorials/anglestut.rst b/docs/tutorials/anglestut.rst
@@ -66,7 +66,7 @@ To initalise a dec class:
 
 HP Notation (hpa)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Hemispheric Positive notation expresses latitude and longitude as positive values with hemisphere indicators.
+HP notation expresses latitude and longitude as positive values with hemisphere indicators.
 
 - **Format:** ``ddd.mmssss``
 - **Example:** ``123.231524°``
@@ -97,7 +97,10 @@ To initalise a gona class:
 Using Angle Classes
 --------------------
 
-First import GeodePy
+Angle classes can be used to hold angle variables, transform to different angle types and 
+complete arthimitc. These will be explored below.
+
+First import GeodePy.
 
 .. code:: python
 
@@ -124,7 +127,7 @@ Using this class we can get individual variables for degree minute and seconds c
     >>5
     >>42
 
-The methods within the class can also be used to convert the angle into different types. This is seen below:
+The methods within the class can also be used to convert the angle into different types.
 
 .. code:: python
 
@@ -140,9 +143,10 @@ The methods within the class can also be used to convert the angle into differen
     >>30.0542
     >>0.5252568383876934
 
-This can be completed with any of the 5 angle classes within GeodePy. To complete math on the angle classes the following can be completed.
+This can be completed with any of the 5 angle classes within GeodePy. 
 
-First a new angle needs to be defined. This will be done using the DDM Angle class
+Arthimitc can be completed on angle classes as seen below. First a new angle needs to be defined. 
+This will be done using the DDM Angle class
 
 .. code:: python
 
diff --git a/docs/tutorials/coordtut.rst b/docs/tutorials/coordtut.rst
@@ -21,7 +21,7 @@ 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 seperation between ellipsoid and geiod.
 
 - **Description:** Defines a point by its distance along three perpendicular axes.
 - **Format:** ``(X, Y, Z)`` in meters.
@@ -68,7 +68,10 @@ To initalise a transverse mercator coordinate class:
 Converting Between Classes
 --------------------------
 
-First import GeodePy
+Coordinate classes can be used to hold coordinate variables and convert between different coordinate types. 
+This will be explored here.
+
+First import GeodePy.
 
 .. code:: python
 
@@ -79,7 +82,7 @@ We can now create a coordinate obect. For this example we will use a transverse
 
 .. code:: python
 
-    coord1 = geodepy.coord.CoordTM(55, 696053.337, 6086610.13)
+    coord1 = geodepy.coord.CoordTM(55, 696053.337, 6086610.13) #(zone, E, N)
     print(coord1)
 
     >>CoordTM: Zone: 55 East: 696053.337 North: 6086610.13 Ell_Ht: None Orth_Ht: None Hemisphere: South
@@ -113,7 +116,7 @@ Instead of using classes, function can also be used to convert between coordinat
 
 Both of these functions can be reversed to convert the other way.
 
-To convert using function first geodepy needs to be imported
+To convert using functions first geodepy needs to be imported.
 
 .. code:: python
 
@@ -124,12 +127,17 @@ Now either of the functions can be used
 
 .. code:: python
 
-    coordGeo = geodepy.convert.grid2geo(55, 696053.337, 6086610.13)
+    coordGeo = geodepy.convert.grid2geo(55, 696053.337, 6086610.13) #zone, E, N
     print(coordGeo)
 
     >>(-35.34455523, 149.15740394, 1.0000737, 1.2484390010290551)
 
-    coordllh = geodepy.convert.xyz2llh(-4471828.926838844, 2670252.9985762094, -3669113.8962611817)
+    coordllh = geodepy.convert.xyz2llh(
+        -4471828.926838844, #x
+        2670252.9985762094, #y
+        -3669113.8962611817 #z
+    )
+
     print(coordllh)
 
     >>(-35.34455523, 149.15740394, 0)
@@ -138,7 +146,7 @@ These function can be used together to convert between grid and cartesian.
 
 .. code:: python
 
-    coordGeo = geodepy.convert.grid2geo(55, 696053.337, 6086610.13)
+    coordGeo = geodepy.convert.grid2geo(55, 696053.337, 6086610.13) #zone, E, N
     coordCart = geodepy.convert.llh2xyz(coordGeo[0],coordGeo[1])
     print(coordCart)
 
diff --git a/docs/tutorials/edmcorrectiontut.rst b/docs/tutorials/edmcorrectiontut.rst
@@ -16,7 +16,7 @@ Within GeodePy, EDM corrections can be completed. To complete an EDM correction
 
 Using these we can calculate the first velocity correction and reduce to a horizontal distance.
 
-First the variables need to be defined. Below is the values for a Lecia Viva.
+First, the variables need to be defined. Below is the values for a Lecia Viva.
 
 .. code:: python
 
@@ -35,7 +35,7 @@ First the variables need to be defined. Below is the values for a Lecia Viva.
 First Velocity Parameters
 -------------------------
 
-Now we can calculate the first velocity parameters
+Now we can calculate the first velocity parameters.
 
 .. code:: python
 
diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst
@@ -3,14 +3,23 @@
 Tutorials
 ===========
 
-.. toctree::
-   :maxdepth: 2
+This section contains a selection of tutorials that showcase the main features of GeodePy.
+It is recommended to complete these tutorials in the order seen below however each tutorial 
+is self-contained.
 
-   anglestut
-   coordtut
-   vincentytut
-   edmcorrectiontut
-   sinextut
-   transformtut
-   timedeptranstut
-   verticaldatumtut
+These tutorials should be used as a guide only, with any final calculations being checked 
+by a compotent professional. 
+
+.. container:: collapsible-toc
+
+   .. toctree::
+      :maxdepth: 2
+
+      anglestut
+      coordtut
+      vincentytut
+      edmcorrectiontut
+      transformtut
+      timedeptranstut
+      verticaldatumtut
+      sinextut
diff --git a/docs/tutorials/juypter notebooks/GeodePy Tutorial - Angles.ipynb b/docs/tutorials/juypter notebooks/GeodePy Tutorial - Angles.ipynb
@@ -96,7 +96,7 @@
       "metadata": {},
       "source": [
         "## HP Notation (HPA)\n",
-        "Hemispheric Positive notation expresses latitude/longitude as positive values with hemisphere indicators.\n",
+        "HP notation expresses latitude/longitude as positive values with hemisphere indicators.\n",
         "\n",
         "- **Format:** `ddd.mmssss`\n",
         "- **Example:** `123.231524°`\n"
diff --git a/docs/tutorials/sinextut.rst b/docs/tutorials/sinextut.rst
diff --git a/docs/tutorials/timedeptranstut.rst b/docs/tutorials/timedeptranstut.rst
diff --git a/docs/tutorials/transformtut.rst b/docs/tutorials/transformtut.rst
diff --git a/docs/tutorials/verticaldatumtut.rst b/docs/tutorials/verticaldatumtut.rst
diff --git a/docs/tutorials/vincentytut.rst b/docs/tutorials/vincentytut.rst
