kmService

Documentation: https://open-imx.github.io/kmService/

Source Code: https://github.com/open-imx/kmService/

PyPi: https://pypi.org/project/kmService/

The dutch rail infrastructure utilizes kilometer measurements to pinpoint the location of objects along the linear infrastructure. This service aims to give you reference information from km and geocodes.

Location Determination and Accuracy Disclaimer¶

While every effort has been made to ensure accuracy, it is important to note that location-based services are subject to inherent limitations and uncertainties. Therefore, users are advised to use the provided location information cautiously and not solely rely on it for critical decision-making purposes. We cannot guarantee the absolute accuracy or completeness of the data and hereby disclaim any warranties, express or implied, regarding its reliability or fitness for a particular purpose.

By utilizing this application and its location-based features, users acknowledge and accept the inherent limitations and uncertainties associated with location determination.

Open-IMX Initiative¶

This open source project is part of the Open-IMX initiative. This initiative aims to provide a collaborative environment for developers, data analysts and railway professionals to effectively work with IMX data.

🗪 Discord Community Channel¶

💥 We invite you to join the 👉 open-imx community on Discord.

Features¶

✅ get actual km data from arcgis feature service
✅ correct hm raai to hm points
✅ get geocode info by xy
✅ get km measure and ribbon by xy
✅ km measure and ribbon as imx string (IMXv1-v12)

Backlog and Issues¶

backlog/roadmap and progress see https://github.com/orgs/open-imx/projects/6
issues see https://github.com/open-imx/kmService/issues

Install¶

pip install kmService

Usage¶

async def async_example():
    from kmService import KmService

    km_service_instance = await KmService.factory()
    return km_service_instance

def sync_example():
    from kmService import get_km_service

    # we use the get_km_service methode, and use async in the background 🎉
    km_service_instance = get_km_service()
    return km_service_instance

response = km_service_instance.get_km(x, y)
print(response.display)
print(response.geojson_string())

This project is depends on the following awesome stuff!¶

Shapely: https://pypi.org/project/shapely/
arcGisFeatureCache: https://pypi.org/project/arcGisFeatureCache/
pyproj https://pypi.org/project/pyproj/
rtree https://pypi.org/project/Rtree/
nest_asyncio https://pypi.org/project/nest-asyncio/
mkdocs-material https://pypi.org/project/mkdocs-material/
mkdocstrings https://pypi.org/project/mkdocstrings/

License¶

This project is licensed under the terms of the MIT license.