Skip to content

Commit

Permalink
docs: front page with cards and icons
Browse files Browse the repository at this point in the history
  • Loading branch information
tsutterley committed Jan 2, 2025
1 parent a98e78b commit 1094b9b
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 118 deletions.
1 change: 0 additions & 1 deletion doc/source/getting_started/Getting-Started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
Getting Started
===============

This documentation is intended to explain how to compute ocean, solid Earth, load and pole tide variations using the set of ``pyTMD`` programs.
See the `background material <./Background.html>`_ and `glossary <./Glossary.html>`_ for more information on the theory and methods used in ``pyTMD``.

Tide Model Formats
Expand Down
111 changes: 0 additions & 111 deletions doc/source/getting_started/Overview.rst

This file was deleted.

72 changes: 67 additions & 5 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,76 @@
pyTMD
=====
===================
pyTMD Documentation
===================

Python-based tidal prediction software for estimating
ocean, load, solid Earth and pole tides
Welcome to the documentation for ``pyTMD``, a Python-based tidal prediction software.
This documentation is intended to explain how to compute ocean, solid Earth, load and pole tide variations using the set of ``pyTMD`` programs.

Introduction
------------

.. grid:: 2 2 4 4
:padding: 0

.. grid-item-card:: Installation
:text-align: center
:link: ./getting_started/Install.html

:material-outlined:`download;5em`

.. grid-item-card:: Getting Started
:text-align: center
:link: ./getting_started/Getting-Started.html

:material-outlined:`hiking;5em`

.. grid-item-card:: Background
:text-align: center
:link: ./getting_started/Background.html

:material-outlined:`library_books;5em`

.. grid-item-card:: Examples
:text-align: center
:link: ./user_guide/Examples.html

:material-outlined:`apps;5em`


Contribute
----------

.. grid:: 2 2 4 4
:padding: 0

.. grid-item-card:: Guidelines
:text-align: center
:link: ./getting_started/Contributing.html

:material-outlined:`groups;5em`

.. grid-item-card:: Code of Conduct
:text-align: center
:link: ./getting_started/Code-of-Conduct.html

:material-outlined:`gavel;5em`

.. grid-item-card:: Discussions
:text-align: center
:link: https://github.com/tsutterley/pyTMD/discussions

:material-outlined:`forum;5em`

.. grid-item-card:: Issues
:text-align: center
:link: https://github.com/tsutterley/pyTMD/issues

:material-outlined:`bug_report;5em`

.. toctree::
:maxdepth: 2
:hidden:
:caption: Getting Started

getting_started/Overview.rst
getting_started/Install.rst
getting_started/Getting-Started.rst
getting_started/Background.rst
Expand Down
1 change: 0 additions & 1 deletion doc/source/release_notes/release-v2.1.9.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
* ``feat``: add calculation of zenith angle `(#363) <https://github.com/tsutterley/pyTMD/pull/363>`_
* ``test``: add zenith angle test `(#363) <https://github.com/tsutterley/pyTMD/pull/363>`_
* ``feat``: expose buffer distance to crop tide model data for `#367 <https://github.com/tsutterley/pyTMD/issues/367>`_ `(#368) <https://github.com/tsutterley/pyTMD/pull/368>`_
* ``feat``: expose buffer distance to crop tide model data for `#367 <https://github.com/tsutterley/pyTMD/issues/367>`_ `(#368) <https://github.com/tsutterley/pyTMD/pull/368>`_
* ``test``: add constituent parameter test `(#368) <https://github.com/tsutterley/pyTMD/pull/368>`_
* ``ci``: add windows build for `#98 <https://github.com/tsutterley/pyTMD/issues/98>`_ `(#369) <https://github.com/tsutterley/pyTMD/pull/369>`_
* ``fix``: omega and phase in constituent parameters `(#369) <https://github.com/tsutterley/pyTMD/pull/369>`_
Expand Down
1 change: 1 addition & 0 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dependencies:
- netCDF4
- notebook
- numpy
- pandas
- pip
- pyproj
- python>=3.6
Expand Down

0 comments on commit 1094b9b

Please sign in to comment.