Skip to content

Commit

Permalink
switching primary branch to main
Browse files Browse the repository at this point in the history
update documentation and readme for branch changes

generalize build opener function for different Earthdata instances

update reduce OTIS files for python3 and projections

add test tidal ellipse program

adjust dimensions of input coordinates to be iterable
  • Loading branch information
tsutterley committed Sep 24, 2020
1 parent 96dc966 commit b5e0e0e
Show file tree
Hide file tree
Showing 59 changed files with 390 additions and 211 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ pyTMD
=====

[![Language](https://img.shields.io/badge/python-v3.7-green.svg)](https://www.python.org/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/tsutterley/pyTMD/blob/master/LICENSE)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/tsutterley/pyTMD/blob/main/LICENSE)
[![PyPI Version](https://img.shields.io/pypi/v/pyTMD.svg)](https://pypi.python.org/pypi/pyTMD/)
[![Documentation Status](https://readthedocs.org/projects/pytmd/badge/?version=latest)](https://pytmd.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/tsutterley/pyTMD/branch/master/graph/badge.svg)](https://codecov.io/gh/tsutterley/pyTMD)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tsutterley/pyTMD/master)
[![Binder](https://binder.pangeo.io/badge.svg)](https://binder.pangeo.io/v2/gh/tsutterley/pyTMD/master)
[![codecov](https://codecov.io/gh/tsutterley/pyTMD/branch/main/graph/badge.svg)](https://codecov.io/gh/tsutterley/pyTMD)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/tsutterley/pyTMD/main)
[![Binder](https://binder.pangeo.io/badge.svg)](https://binder.pangeo.io/v2/gh/tsutterley/pyTMD/main)

#### Python-based tidal prediction software that reads OTIS, GOT and FES formatted tidal solutions for calculating ocean and load tides

Expand Down Expand Up @@ -57,7 +57,7 @@ L. Padman, M. R. Siegfried, H. A. Fricker,
The program homepage is:
https://github.com/tsutterley/pyTMD
A zip archive of the latest version is available directly at:
https://github.com/tsutterley/pyTMD/archive/master.zip
https://github.com/tsutterley/pyTMD/archive/main.zip

#### Software
Matlab Tide Model Driver from Earth & Space Research is available at:
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Tyler C. Sutterley'

# The full version, including alpha/beta/rc tags
release = '1.0.2.12'
release = '1.0.2.13'


# -- General configuration ---------------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions doc/source/getting_started/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Getting Started

#### Tide Model Formats
OTIS and ATLAS formatted data use a single binary file to store all the constituents for either heights (`z`) or transports (`u`, `v`).
Arctic Ocean models can be downloaded from the NSF ArcticData server using the [`arcticdata_tides.py`](https://github.com/tsutterley/pyTMD/blob/master/scripts/arcticdata_tides.py) program.
CATS2008 can be downloaded from the US Antarctic Program (USAP) using the [`usap_cats_tides.py`](https://github.com/tsutterley/pyTMD/blob/master/scripts/usap_cats_tides.py) program.
Arctic Ocean models can be downloaded from the NSF ArcticData server using the [`arcticdata_tides.py`](https://github.com/tsutterley/pyTMD/blob/main/scripts/arcticdata_tides.py) program.
CATS2008 can be downloaded from the US Antarctic Program (USAP) using the [`usap_cats_tides.py`](https://github.com/tsutterley/pyTMD/blob/main/scripts/usap_cats_tides.py) program.
ATLAS netCDF formatted data use netCDF4 files for each constituent and variable type (`z`, `u`, `v`).
GOT formatted data use ascii files for each height constituent (`z`).
FES formatted data use either ascii (1999, 2004) or netCDF4 (2012, 2014) files for each constituent and variable type (`z`, `u`, `v`).
The FES models can be downloaded using the [`aviso_fes_tides.py`](https://github.com/tsutterley/pyTMD/blob/master/scripts/aviso_fes_tides.py) program for users registered with AVISO.
The FES models can be downloaded using the [`aviso_fes_tides.py`](https://github.com/tsutterley/pyTMD/blob/main/scripts/aviso_fes_tides.py) program for users registered with AVISO.

#### Directories
pyTMD uses a tree structure for storing the tidal constituent data.
Expand Down Expand Up @@ -45,14 +45,14 @@ This structure was chosen based on the different formats of each tide model.
* [FES2014_load](https://www.aviso.altimetry.fr/data/products/auxiliary-products/global-tide-fes.html): `<path_to_tide_models>/fes2014/load_tide/`

#### Programs
For users wanting to compute tide corrections for use with numpy arrays or pandas data structures, [`compute_tide_corrections.py`](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/compute_tide_corrections.py) is the place to start. It is a function that takes x, y, and time coordinates and computes the corresponding tidal elevation.
For users wanting to compute tide corrections for use with numpy arrays or pandas data structures, [`compute_tide_corrections.py`](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/compute_tide_corrections.py) is the place to start. It is a function that takes x, y, and time coordinates and computes the corresponding tidal elevation.
```python
tide = compute_tide_corrections(x, y, delta_time, DIRECTORY=path_to_tide_models,
MODEL='CATS2008', EPSG=3031, EPOCH=(2000,1,1,0,0,0), TYPE='drift', TIME='GPS',
METHOD='spline', FILL_VALUE=np.nan)
```

For users wanting to calculate tidal elevations or currents for a series of files, the [`compute_tidal_elevations.py`](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tidal_elevations.py) and [`compute_tidal_currents.py`](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tidal_currents.py) programs cover most use cases. They take an input file (in csv, netCDF4 or HDF5) and compute the tidal elevations or currents (zonal and meridonal) for each point.
For users wanting to calculate tidal elevations or currents for a series of files, the [`compute_tidal_elevations.py`](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tidal_elevations.py) and [`compute_tidal_currents.py`](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tidal_currents.py) programs cover most use cases. They take an input file (in csv, netCDF4 or HDF5) and compute the tidal elevations or currents (zonal and meridonal) for each point.
```bash
python compute_tidal_elevations.py --directory=<path_to_tide_models> --tide=CATS2008 \
--format=HDF5 --variables=t_sec,lat,lon,h_cor --projection=4326 \
Expand All @@ -65,4 +65,4 @@ python compute_tidal_currents.py --directory=<path_to_tide_models> --tide=CATS20
input_file.H5 output_file.H5
```

There are specific programs for correcting NASA [Operation IceBridge](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_icebridge_data.py), [ICESat-2 ATL03 geolocated photon](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL03.py), [ICESat-2 ATL06 land ice](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL06.py), [ICESat-2 ATL07 sea ice](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL07.py) and [ICESat-2 ATL12 ocean surface](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL12.py) data.
There are specific programs for correcting NASA [Operation IceBridge](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_icebridge_data.py), [ICESat-2 ATL03 geolocated photon](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL03.py), [ICESat-2 ATL06 land ice](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL06.py), [ICESat-2 ATL07 sea ice](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL07.py) and [ICESat-2 ATL12 ocean surface](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL12.py) data.
4 changes: 2 additions & 2 deletions doc/source/getting_started/Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Installation
============

Presently pyTMD is available for use as a [GitHub repository](https://github.com/tsutterley/pyTMD) and from the [Python Package Index (pypi)](https://pypi.org/project/pyTMD/).
The contents of the repository can be download from GitHub as a [zipped file](https://github.com/tsutterley/pyTMD/archive/master.zip) or cloned.
The contents of the repository can be download from GitHub as a [zipped file](https://github.com/tsutterley/pyTMD/archive/main.zip) or cloned.
To use this repository from GitHub, please fork into your own account and then clone onto your system.
```bash
git clone https://github.com/tsutterley/pyTMD.git
Expand All @@ -21,4 +21,4 @@ To install from pypi using pip
python3 -m pip install --user pyTMD
```

Executable versions of this repository can also be tested using [Binder](https://mybinder.org/v2/gh/tsutterley/pyTMD/master) and [Pangeo](https://binder.pangeo.io/v2/gh/tsutterley/pyTMD/master).
Executable versions of this repository can also be tested using [Binder](https://mybinder.org/v2/gh/tsutterley/pyTMD/main) and [Pangeo](https://binder.pangeo.io/v2/gh/tsutterley/pyTMD/main).
2 changes: 1 addition & 1 deletion doc/source/user_guide/arcticdata_tides.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ arcticdata_tides.py
```bash
python arcticdata_tides.py --directory=<path_to_tide_directory> --tide=AOTIM-5-2018
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/arcticdata_tides.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/arcticdata_tides.py)

#### Command Line Options
- `-D X`, `--directory=X`: Working Data Directory
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/aviso_fes_tides.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ aviso_fes_tides.py
```bash
python aviso_fes_tides.py --directory=<path_to_tide_directory> --tide=fes2014
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/aviso_fes_tides.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/aviso_fes_tides.py)

#### Command Line Options
- `-D X`, `--directory=X`: Working Data Directory
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/bilinear_interp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ bilinear_interp.py
from pyTMD.bilinear_interp import bilinear_interp
data = bilinear_interp(ilon,ilat,idata,lon,lat)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/bilinear_interp.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/bilinear_interp.py)

#### Inputs
1. `ilon`: longitude of tidal model
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/calc_astrol_longitudes.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ calc_astrol_longitudes.py
from pyTMD.calc_astrol_longitudes import calc_astrol_longitudes
s,h,p,N,PP = calc_astrol_longitudes(MJD, ASTRO5=True)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/calc_astrol_longitudes.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/calc_astrol_longitudes.py)

#### Inputs
1. `MJD`: Modified Julian Day of input date
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/calc_delta_time.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ calc_delta_time.py
from pyTMD.calc_delta_time import calc_delta_time
deltat = calc_delta_time(delta_file, idays)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/calc_delta_time.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/calc_delta_time.py)

#### Inputs
1. `delta_file`:
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_LPET_elevations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ compute_LPET_elevation.py
```bash
python compute_LPET_elevation.py input_file output_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/compute_LPET_elevation.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/compute_LPET_elevation.py)

#### Inputs
1. `input_file`: name of input file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_LPET_icebridge_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ compute_LPET_icebridge_data.py
```bash
python compute_LPET_icebridge_data.py --verbose input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/compute_LPET_icebridge_data.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/compute_LPET_icebridge_data.py)

#### Inputs
1. `input_file`: input ATM1B, ATM icessn or LVIS file from NSIDC
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_LPT_displacements.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ compute_LPT_displacements.py
```bash
python compute_LPT_displacements.py --directory=<path_to_directory> input_file output_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_LPT_displacements.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_LPT_displacements.py)

#### Inputs
1. `input_file`: name of input file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_LPT_icebridge_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ compute_LPT_icebridge_data.py
```bash
python compute_LPT_icebridge_data.py --directory=<path_to_directory> input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/compute_LPT_icebridge_data.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/compute_LPT_icebridge_data.py)

#### Inputs
1. `input_file`: input ATM1B, ATM icessn or LVIS file from NSIDC
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_OPT_displacements.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ compute_OPT_displacements.py
```bash
python compute_OPT_displacements.py --directory=<path_to_directory> input_file output_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_OPT_displacements.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_OPT_displacements.py)

#### Inputs
1. `input_file`: name of input file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_OPT_icebridge_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ compute_OPT_icebridge_data.py
```bash
python compute_OPT_icebridge_data.py --directory=<path_to_directory> input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_OPT_icebridge_data.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_OPT_icebridge_data.py)

#### Inputs
1. `input_file`: input ATM1B, ATM icessn or LVIS file from NSIDC
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_equilibrium_tide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ compute_equilibrium_tide.py
from pyTMD.compute_equilibrium_tide import compute_equilibrium_tide
lpet = compute_equilibrium_tide(time,lat)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/compute_equilibrium_tide.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/compute_equilibrium_tide.py)

#### Inputs
1. `t`: days relative to Jan 1, 1992 (48622mjd)
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tidal_currents.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ compute_tidal_currents.py
```bash
python compute_tidal_currents.py --directory=<path_to_directory> --tide=<model> input_file output_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tidal_currents.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tidal_currents.py)

#### Inputs
1. `input_file`: name of input file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tidal_elevations.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ compute_tidal_elevations.py
```bash
python compute_tidal_elevations.py --directory=<path_to_directory> --tide=<model> input_file output_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tidal_elevations.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tidal_elevations.py)

#### Inputs
1. `input_file`: name of input file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tide_corrections.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ from pyTMD.compute_tide_corrections import compute_tide_corrections
tide = compute_tide_corrections(x, y, delta_time, DIRECTORY=DIRECTORY,
MODEL=MODEL, EPOCH=(2000,1,1,0,0,0), EPSG=3031, TYPE='drift')
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/compute_tide_corrections.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/compute_tide_corrections.py)

#### Inputs
1. `x`: x-coordinates in projection EPSG
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tides_ICESat2_ATL03.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ compute_tides_ICESat2_ATL03.py
```bash
python compute_tides_ICESat2_ATL03.py --directory=<path_to_directory> --tide=<model> input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL03.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL03.py)

#### Inputs
1. `input_file`: input ICESat-2 ATL03 file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tides_ICESat2_ATL06.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ compute_tides_ICESat2_ATL06.py
```bash
python compute_tides_ICESat2_ATL06.py --directory=<path_to_directory> --tide=<model> input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL06.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL06.py)

#### Inputs
1. `input_file`: input ICESat-2 ATL06 file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tides_ICESat2_ATL07.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ compute_tides_ICESat2_ATL07.py
```bash
python compute_tides_ICESat2_ATL07.py --directory=<path_to_directory> --tide=<model> input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL07.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL07.py)

#### Inputs
1. `input_file`: input ICESat-2 ATL07 file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tides_ICESat2_ATL12.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ compute_tides_ICESat2_ATL12.py
```bash
python compute_tides_ICESat2_ATL12.py --directory=<path_to_directory> --tide=<model> input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_ICESat2_ATL12.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_ICESat2_ATL12.py)

#### Inputs
1. `input_file`: input ICESat-2 ATL12 file
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/compute_tides_icebridge_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ compute_tides_icebridge_data.py
```bash
python compute_tides_icebridge_data.py --directory=<path_to_directory> --tide=<model> input_file
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/scripts/compute_tides_icebridge_data.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/scripts/compute_tides_icebridge_data.py)

#### Inputs
1. `input_file`: input ATM1B, ATM icessn or LVIS file from NSIDC
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/convert_calendar_decimal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ from pyTMD.convert_calendar_decimal import convert_calendar_decimal
t_date = convert_calendar_decimal(year, month, DAY=day, \
HOUR=hour, MINUTE=minute, SECOND=second)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/convert_calendar_decimal.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/convert_calendar_decimal.py)

#### Inputs
1. `year`: calendar year
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/convert_julian.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ convert_julian.py
from pyTMD.convert_julian import convert_julian
YEAR,MONTH,DAY,HOUR,MINUTE,SECOND = convert_julian(JD, FORMAT='tuple')
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/convert_julian.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/convert_julian.py)

#### Inputs
1. `JD`: Julian Day of the specified calendar date (days since -4712-01-01T12:00:00)
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/convert_ll_xy.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ from pyTMD.convert_ll_xy import convert_ll_xy
x,y = convert_ll_xy(lon,lat,PROJ,'F')
lon,lat = convert_ll_xy(x,y,PROJ,'B')
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/convert_ll_xy.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/convert_ll_xy.py)

#### Inputs
1. `i1`: longitude ('F') or projection easting x ('B')
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/count_leap_seconds.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ count_leap_seconds.py
from pyTMD.count_leap_seconds import count_leap_seconds
n_leaps = count_leap_seconds(GPS_Time)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/count_leap_seconds.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/count_leap_seconds.py)

#### Inputs
1. `GPS_Time`: seconds since January 6, 1980 at 00:00:00
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/iers_mean_pole.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ iers_mean_pole.py
from pyTMD.iers_mean_pole import iers_mean_pole
x,y,flag = iers_mean_pole(input_file,input_epoch,version,FILL_VALUE=FILL_VALUE)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/iers_mean_pole.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/iers_mean_pole.py)

#### Inputs
1. `input_file`: full path to mean-pole.tab file provided by IERS
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/infer_minor_corrections.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ from pyTMD.infer_minor_corrections import infer_minor_corrections
dh = infer_minor_corrections(t, zmajor, constituents,
DELTAT=DELTAT, CORRECTIONS=CORRECTIONS)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/infer_minor_corrections.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/infer_minor_corrections.py)

#### Inputs
1. `t`: days relative to Jan 1, 1992 (48622mjd)
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/load_constituent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ load_constituent.py
from pyTMD.load_constituent import load_constituent
amplitude,phase,omega,alpha,species = load_constituent(c)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/load_constituent.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/load_constituent.py)

#### Inputs
1. `c`: tidal constituent IDs
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/load_nodal_corrections.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ load_nodal_corrections.py
from pyTMD.load_nodal_corrections import load_nodal_corrections
pu,pf,G = load_nodal_corrections(MJD,constituents)
```
[Source code](https://github.com/tsutterley/pyTMD/blob/master/pyTMD/load_nodal_corrections.py)
[Source code](https://github.com/tsutterley/pyTMD/blob/main/pyTMD/load_nodal_corrections.py)

#### Inputs
1. `MJD`: Modified Julian Day of input date
Expand Down
Loading

0 comments on commit b5e0e0e

Please sign in to comment.