Metadata-Version: 2.4
Name: seavoyage
Version: 0.1.4
Summary: An improved version of searoute package for calculating the shortest sea route between two points on Earth.
Home-page: https://github.com/a22106/seavoyage
Author: Byeonggong Hwang
Author-email: bk22106@gmail.com
License: Apache 2.0
Keywords: sea route,shortest path,graph,geojson,networkx
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: GIS
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: geojson==3.2.0
Requires-Dist: networkx==3.4.2
Requires-Dist: setuptools==75.8.0
Requires-Dist: searoute==1.4.2
Requires-Dist: folium==0.16.0
Requires-Dist: shapely==2.0.7
Requires-Dist: geopandas==1.0.1
Requires-Dist: fiona==1.10.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Sea Voyage

Sea Voyage는 지구상의 두 지점 간 최단 해상 경로를 계산하는 Python 패키지입니다. 이 패키지는 [searoute](https://github.com/genthalili/searoute-py) 패키지를 기반으로 개선되었습니다.

## 원본 프로젝트
- 원본 패키지: [searoute](https://github.com/genthalili/searoute-py)
- 원작자: Gent Halili
- 라이선스: Apache License 2.0

## 주요 개선사항
1. 성능 최적화
   - TODO: 경로 계산 속도 향상
2. 기능 추가
   - 다양한 해상도의 Graph 형태 지원(5km, 10km, 25km, 50km, 100km)
   - 다양하고 쉬운 방법으로 graph에 node 및 edge 추가 가능
   - 육지를 지나거나 육지 위의 node 및 edge 제거 가능
   - TODO: 새로운 해상 경로 옵션 추가

## 설치 방법
```bash
pip install seavoyage
```

## 사용 예시

### 1. 기본 경로 생성
```python
import seavoyage as sv

# 출발지와 목적지 좌표 설정(longitude, latitude)
origin = [0.3515625, 50.064191736659104]
destination = [117.42187500000001, 39.36827914916014]

# 경로 계산
route = sv.voyage(origin, destination)

# 거리 및 단위 출력
print("{:.1f} {}".format(route.properties['length'], route.properties['units'])) # 
```

### 2. 해상도 변경
```python
import seavoyage as sv

# 해상도 변경
m_network = sv.get_m_network_5km()

# 경로 계산
route = sv.voyage(origin, destination, M=m_network)

# 거리 및 단위 출력
print("{:.1f} {}".format(route.properties['length'], route.properties['units']))
```


## 라이선스
이 프로젝트는 Apache License 2.0 라이선스 하에 배포됩니다.

```
Copyright 2024 - Gent Halili (원작자)
Copyright 2025 - Byeonggong Hwang

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

## 기여
버그 리포트, 기능 제안, 풀 리퀘스트는 언제나 환영합니다.

## 연락처
- 이메일: bk22106@gmail.com
- GitHub: [a22106](https://github.com/a22106)
