Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@ShogoHirasawa
ShogoHirasawa authored Mar 29, 2024
1 parent 26a5d1b commit 17350d3
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Plateau Utils

## 1. 概要 <!-- 本リポジトリでOSS化しているソフトウェア・ライブラリについて1文で説明を記載ください -->
本リポジトリでは、Project PLATEAUの令和4年度のユースケース開発業務の一部であるUC23-01「人工衛星観測データを用いた浸水被害把握等」について、その成果物である「Plateau Utils」のソースコードを公開しています。
## 1. 概要
本リポジトリでは、2023年度のProject PLATEAUが開発した「Plateau Utils」のソースコードを公開しています。

「Plateau Utils」は、「PLATEAUで公開されている3D都市モデル（CityGML・3DTiles/MVT）」をパースして、Pythonに読み込むためのPythonライブラリです。
「Plateau Utils」は、PLATEAUで公開されている3D都市モデル（CityGML・3DTiles/MVT）をパースして、Pythonに読み込むためのPythonライブラリです。

## 2. 「人工衛星観測データを用いた浸水被害把握等」について <!-- 「」内にユースケース名称を記載ください。本文は以下のサンプルを参考に記載ください。URLはアクセンチュアにて設定しますので、サンプルそのままでOKです。 -->
「人工衛星観測データを用いた浸水被害把握等」では、洪水等の浸水被害発生直後の人工衛星観測データ（SARデータ）から分析した浸水範囲と3D都市モデルの地形モデル及び建築物モデルをマッチングさせることで、家屋単位での浸水深の算出および被災判定を行うシステムを開発する。さらに、導出された被災家屋リストをデータベース化し、WebGISエンジン「Re:Earth」上で可視化するシステムを構築することで、行政における罹災証明書発行業務の効率化を目指す。
本システムは、人工衛星観測データ（SARデータ）によって取得された浸水範囲と、3D都市モデルが持つ家屋情報を組み合わせて分析する際に、3D都市モデルが持つ家屋情報を取得するために開発されたシステムです。
本システムの詳細については[技術検証レポート](https:XXXX)を参照してください。
## 2. 「Plateau Utils」について
[「SAR衛星解析による洪水被害の推定システム」](https://github.com/Project-PLATEAU/SAR-image-based-flood-damage-detector)では、人工衛星観測データ（SARデータ）から分析した浸水範囲と3D都市モデルの地形モデル及び建築物モデルをマッチングさせることで、家屋単位での浸水深の算出および被災判定を行います。
「Plateau Utils」は、3D都市モデルが持つ家屋の属性情報を抽出し、Pythonライブラリ上で扱えるようにするためのPythonスクリプトです。

## 3. 利用手順 <!-- 下記の通り、GitHub Pagesへリンクを記載ください。URLはアクセンチュアにて設定しますので、サンプルそのままでOKです。 -->
本システムの詳細については[技術検証レポート](https://www.mlit.go.jp/plateau/file/libraries/doc/plateau_tech_doc_0071_ver01.pdf)を参照してください。

## 3. 利用手順
本システムのインストール手順及び利用手順については[利用チュートリアル](https://eukarya-inc.github.io/plateauutils/index.html)を参照してください。

## 4. システム概要 <!-- OSS化対象のシステムが有する機能を記載ください。 -->
## 4. システム概要
### 【3D都市モデルのパーサ】
#### ①3D都市モデル（CityGML）のパース
- 3D都市モデルのCityGMLのZIPファイルのURLを指定することで、3D都市モデルのパースを行うことができる。
Expand All @@ -37,7 +38,7 @@
| | shapely | 2.0.1 | Python Imaging Library (PIL) のフォークとして開発された画像処理ライブラリ |
| | tqdm | 4.65.0 | データのダウンロードの進捗を表示 |

## 6. 動作環境 <!-- 動作環境についての仕様を記載ください。 -->
## 6. 動作環境
- 本ユースケースにおいては、動作環境としてGoogle Colaboratory（2024/02/01時点）を使用しています。

| 項目 | GoogleColaboratoryでの動作環境（2024/02/01時点） | 推奨環境 |
Expand All @@ -47,25 +48,25 @@
| メモリ | 12.7GB以上 | 同左 |
| ネットワーク | ネットワークからのダウンロード機能を使用しない場合はネットワーク環境は不要<br>ネットワークからのダウンロード機能を使用する場合、ネットワークを閲覧できる環境が必要<br> | 同左 |

## 7. 本リポジトリのフォルダ構成 <!-- 本GitHub上のソースファイルの構成を記載ください。 -->
## 7. 本リポジトリのフォルダ構成
| フォルダ名 |　詳細 |
|-|-|
| flood_converter | 浸水を3DTiles、PNG、XYZタイルへ変換する |
| mesh_geocorder | ポリゴンや地物をメッシュコードのリスト化する |
| parser | 読み込んだCityGMLやMVTをパースする |
| tile_list | ポリゴンや地物をタイル化する |

## 8. ライセンス <!-- 変更せず、そのまま使うこと。 -->
## 8. ライセンス

- ソースコード及び関連ドキュメントの著作権は国土交通省に帰属します。
- 本ドキュメントは[Project PLATEAUのサイトポリシー](https://www.mlit.go.jp/plateau/site-policy/)（CCBY4.0及び政府標準利用規約2.0）に従い提供されています。

## 9. 注意事項 <!-- 変更せず、そのまま使うこと。 -->
## 9. 注意事項

- 本リポジトリは参考資料として提供しているものです。動作保証は行っていません。
- 本リポジトリについては予告なく変更又は削除をする可能性があります。
- 本リポジトリの利用により生じた損失及び損害等について、国土交通省はいかなる責任も負わないものとします。

## 10. 参考資料 <!-- 技術検証レポートのURLはアクセンチュアにて記載します。 -->
- 技術検証レポート: https:XXXX
## 10. 参考資料
- 技術検証レポート: https://www.mlit.go.jp/plateau/file/libraries/doc/plateau_tech_doc_0071_ver01.pdf
- PLATEAU WebサイトのUse caseページ「人工衛星観測データを用いた浸水被害把握等」: https://www.mlit.go.jp/plateau/use-case/uc23-01/

0 comments on commit 17350d3

Please sign in to comment.