Skip to content

Commit

Permalink
provide bounds for compat
Browse files Browse the repository at this point in the history
  • Loading branch information
pszufe committed Oct 13, 2023
1 parent e650df6 commit 792e840
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 14 deletions.
10 changes: 9 additions & 1 deletion Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,15 @@ StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"

[compat]
julia = "1.6"

CSV = "0.10"
DataFrames = "1.1, 1.2, 1.3, 1.4, 1.5, 1.6"
EzXML = "1.0, 1.1"
NamedTupleTools="0.14"
OpenStreetMapX="0.2, 0.3"
Parameters="0.10, 0.11, 0.12"
Parsers="2"
SpatialIndexing="0.1.5"
StatsBase = "0.28, 0.29, 0.30, 0.31, 0.32, 0.33, 0.34"
[extras]
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

Expand Down
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@


# Tools for Open Steet Map (OSM) Point-of-Interest (POI) extraction and tiling/slicing of map files.
# Tools for Open Steet Map: Point-of-Interest extraction and tiling of map data

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://pszufe.github.io/OSMToolset.jl/)

The goal of the package is to provide a fast and convenient interaface for extraction data from OpenStreetMap project and for construction of walkability indexes based on map data.
The maps provided by the OpenStreetMap project contain very detailed information about schools, businesses, shops, restaurants, cafes, parking spaces, hospitals etc. The goal of this tools is to provide an effient API for extraction of data on such points of interest (POIs) for further processing. This information can be further used e.g. to build walkability indexes that can be used to explain attractiveness of some parts of a city. Hence the second functionality of the package is to provide an interface (based on the `SpatialInexing.jl` package) for efficient building of attractiveness indexes of any urban area.
Since the OSM map XML files are usully very large, sometimes it is required to tile the files into smailler chunks for efficient parallel processing. Hence, the third functionality of this package is an OSM file tiler.

The package offers the following functionalities:
1. Export points-of-interests (POIs) from a OSM xml map file to a `DataFrame`
Expand Down Expand Up @@ -134,16 +135,12 @@ The OSM tiler is simultanously opening a file writer for each file. The operatin

## Aknowledgments

<sup>This research was funded in whole or in part by [National Science Centre, Poland][2021/41/B/HS4/03349].</sup>
This research was funded by National Science Centre, Poland, grant number 2021/41/B/HS4/03349.

<sup>This tool is using some code from the previous work of Marcin Żurek, under the same research grant. The initial prototype can be found at:
https://github.com/mkloe/OSMgetPOI.jl</sup>


<!-- [![Build Status](https://github.com/pszufe/OSMToolset.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/pszufe/OSMToolset.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Build Status](https://travis-ci.com/pszufe/OSMToolset.jl.svg?branch=main)](https://travis-ci.com/pszufe/OSMToolset.jl)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/pszufe/OSMToolset.jl?svg=true)](https://ci.appveyor.com/project/pszufe/OSMToolset-jl)
[![Build Status](https://api.cirrus-ci.com/github/pszufe/OSMToolset.jl.svg)](https://cirrus-ci.com/github/pszufe/OSMToolset.jl)
[![Coverage](https://codecov.io/gh/pszufe/OSMToolset.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/pszufe/OSMToolset.jl)
[![Coverage](https://coveralls.io/repos/github/pszufe/OSMToolset.jl/badge.svg?branch=main)](https://coveralls.io/github/pszufe/OSMToolset.jl?branch=main) -->
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ There is also a [Visualization](visualize.md) example.

## Aknowledgments

<sup>This research was funded in whole or in part by [National Science Centre, Poland][2021/41/B/HS4/03349]. </sup>
This research was funded by National Science Centre, Poland grant number 2021/41/B/HS4/03349.

12 changes: 7 additions & 5 deletions src/OSMToolset.jl
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
module OSMToolset

using CSV, DataFrames
using CSV
using DataFrames
using SpatialIndexing
using StatsBase
using NamedTupleTools
using Parsers, EzXML, Parameters
using Parsers
using EzXML
using Parameters
import OpenStreetMapX
import OpenStreetMapX: OSMData, LLA, ENU, distance
import OpenStreetMapX: LLA, ENU, distance


include("common.jl")
include("tile.jl")
include("poi.jl")
include("attractiveness.jl")

include("tile.jl")

export tile_osm_file
export FloatLon
Expand Down

2 comments on commit 792e840

@pszufe
Copy link
Owner Author

@pszufe pszufe commented on 792e840 Oct 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/93341

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 792e840d4a41936c2ca23fae5f6c1432d25ef480
git push origin v0.1.0

Please sign in to comment.