diff --git a/README.md b/README.md index 19e0b44..10e8666 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ [![Test](https://github.com/MIERUNE/japan-geoid/actions/workflows/test.yml/badge.svg)](https://github.com/MIERUNE/japan-geoid/actions/workflows/test.yml) [![Maturin](https://github.com/MIERUNE/japan-geoid/actions/workflows/maturin.yml/badge.svg)](https://github.com/MIERUNE/japan-geoid/actions/workflows/maturin.yml) [![codecov](https://codecov.io/gh/MIERUNE/japan-geoid/graph/badge.svg?token=c9T2ayChfw)](https://codecov.io/gh/MIERUNE/japan-geoid) -![Crates.io Version](https://img.shields.io/crates/v/japan-geoid) -![PyPI - Version](https://img.shields.io/pypi/v/japan-geoid) -![NPM Version](https://img.shields.io/npm/v/japan-geoid) +[![Crates.io Version](https://img.shields.io/crates/v/japan-geoid)](https://crates.io/crates/japan-geoid) +[![PyPI - Version](https://img.shields.io/pypi/v/japan-geoid)](https://pypi.org/project/japan-geoid/) +[![NPM Version](https://img.shields.io/npm/v/japan-geoid)](https://www.npmjs.com/package/japan-geoid) -A Rust, Python and JavaScript (WASM) library for calculating geoid heights in Japan using [GSI's geoid model](https://fgd.gsi.go.jp/download/geoid.php). This library contains geoid data based on `gsigeo2011_ver2_2.asc`, created with permission: 「測量法に基づく国土地理院長承認(使用)R 5JHs 560」. +A library for calculating geoid heights in Japan using GSI's geoid model. It is implemented in Rust and additionally supports Python and JavaScript. The library contains geoid data based on GSIGEO2011 (`gsigeo2011_ver2_2.asc`), created with the permission: 「測量法に基づく国土地理院長承認(使用)R 5JHs 560」. -Rust, Python, JavaScript で日本のジオイド高を計算するためライブラリです。国土地理院のジオイドモデル「[日本のジオイド2011](https://fgd.gsi.go.jp/download/geoid.php)」を用いて、国土地理院による C++ のサンプルコードに準拠した補間計算を行います。本ライブラリは、日本のジオイド2011 v.2.2 (`gsigeo2011_ver2_2.asc`) を元にしたジオイドデータを含んでいます(測量法に基づく国土地理院長承認(使用)R 5JHs 560)。 +日本のジオイド高を計算するためライブラリです。Rust で実装されており、Python と JavaScript (WASM) でも利用できます。国土地理院のジオイドモデル「[日本のジオイド2011](https://fgd.gsi.go.jp/download/geoid.php)」を用いて、国土地理院による C++ のサンプルコードに準拠した補間計算を行います。本ライブラリには、日本のジオイド2011 v.2.2 (`gsigeo2011_ver2_2.asc`) を元にしたジオイドデータが同梱されています(測量法に基づく国土地理院長承認(使用)R 5JHs 560)。 License: MIT @@ -28,11 +28,13 @@ pip install japan-geoid -U ```python from japan_geoid import load_embedded_gsigeo2011 +# Load the embedded GSIGEO2011 model. geoid = load_embedded_gsigeo2011() +# Calculate the geoid height. (lng, lat) = (138.2839817085188, 37.12378643088312) height = geoid.get_height(lng, lat) -print(f"{lng=} {lat=} -> {height=}") +print(f"{lng=} {lat=} {height=}") # Returns NaN if the input is outside the domain. geoid.get_height(10.0, 10.0)) # => nan