Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions docs/community/contributing.rst
Original file line number Diff line number Diff line change
@@ -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 <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 behaviour when contributing to this project.

Coding Style Guide
------------------
Expand All @@ -26,6 +26,7 @@ Before committing Python changes, run:

ruff format .
ruff check .
typos .

.. _code:

Expand All @@ -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 <http://docutils.sourceforge.net/rst.html>`_,
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 <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.
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 <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,
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 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 <code>`.
4 changes: 2 additions & 2 deletions docs/features/angles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ All **angle classes** can be seen below:
.. autoclass:: geodepy.angles.DDMAngle
:members:

.. _converstions:
.. _conversions:

-------------------

Expand Down Expand Up @@ -132,7 +132,7 @@ For converting **Gradians** to other formats:

-------------------

Other Converstion Functions:
Other Conversion Functions:

.. autofunction:: geodepy.angles.dd2sec

Expand Down
6 changes: 3 additions & 3 deletions docs/features/constants.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down Expand Up @@ -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 <features/height>` module.
The module also contains locations for files commonly used in height conversions that will be used in the :ref:`height <features/height>` module.
2 changes: 1 addition & 1 deletion docs/features/geodesy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Geodesy

This module includes functions for geodetic calculations.

Convertions
Conversions
------------

.. autofunction:: geodepy.geodesy.enu2xyz
Expand Down
2 changes: 1 addition & 1 deletion docs/features/height.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/features/ntv2reader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 9 additions & 10 deletions docs/tutorials/anglestut.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.

12 changes: 6 additions & 6 deletions docs/tutorials/coordtut.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The three different classes are:
- :ref:`CoordGeo - Geographic Coordinates (lat, long, H) <tut/geo>`
- :ref:`CoordTM - Transverse Mercator Coordinates (e, n, H) <tut/tm>`

To learn more about these corrdinate types refer to the `GDA2020 technical manual <https://www.anzlic.gov.au/sites/default/files/files/GDA2020%20Technical%20Manual%20V1.8_published.pdf>`_.
To learn more about these coordinate types refer to the `GDA2020 technical manual <https://www.anzlic.gov.au/sites/default/files/files/GDA2020%20Technical%20Manual%20V1.8_published.pdf>`_.

Classes
--------
Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
{
Expand All @@ -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."
]
},
{
Expand Down Expand Up @@ -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."
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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."
]
},
{
Expand Down Expand Up @@ -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:"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/sinextut.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading
Loading