gtfs_stops_clustering 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf75afd13663d9ebf254d37a24763336b5f411c174f3e8b9743af32c0f3843e9
-  data.tar.gz: 16d82b24fbd8b2170917f87745b68874802f95a151ebe500bf51cba408edd7b1
+  metadata.gz: 3e2e3f607f0439e34962d10515cab56ba2a456113300cbb5819e87d75f6ce039
+  data.tar.gz: 488c0844cf9b633feab97c702c8ba33004bc72bdf0fb3d09246e7727bb5c7813
 SHA512:
-  metadata.gz: 5efc4d7c36b869092e9147f5b350af0178cf968d08e9df1fe94705e7277f19b6d3bccdd91e94ba4c23735a827125263a2ac7dec5dee4768da6314fe49326ea6b
-  data.tar.gz: 01e7f5fa34685099706249c1f40e64f40986fce2fc64a78f8696d6be967a1bbafdc2c5706830d7b5b423d984df3b232e3fe96acc02507a10d5fbb2f23eaa6792
+  metadata.gz: fd6543aa275867c1c711ebb5002b326d3d5b72aab36724d60ec75243e20407ec3a1258ec24895a1087cf23de1b749ec88b6e132938991cc2c03b447f584b3522
+  data.tar.gz: 5acd76e6925e49f2da4bb8bd46d3d7255fa27f9a0d13ee650d9f303bb88b2b9fd14b6d07416f0ff5c62890608684512ae888c29d7d6ba25eea048f168eb57dd6

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
+## 0.1.6
 
-## [0.1.0] - 2023-12-06
+## [0.1.6] - 2023-12-19
+
+- Clean Redis stops data after performing the clustering algorithm
+
+## [0.1.5] - 2023-12-10
 
 - Initial release

data/README.md

@@ -1,24 +1,89 @@
-# GtfsStopsClustering
+# GTFS Stops clustering 
+[![Gem Version](https://badge.fury.io/rb/gtfs_stops_clustering.svg)](https://badge.fury.io/rb/gtfs_stops_clustering)
 
-TODO: Delete this and the text below, and describe your gem
+GTFS Stops Clustering is a Ruby Gem designed to read [GTFS](https://gtfs.org) (General Transit Feed Specification) stops data and create clusters based on the following parameters:
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gtfs_stops_clustering`. To experiment with that code, run `bin/console` for an interactive prompt.
+- `GTFS paths` [Required]: array of gtfs zip files paths whose stops will be combined in the clustering algorithm
+- `Epsilon` [Required]: the maximum distance (in km) between 2 stops for them to be considered neighbors of one another (e.g.: 0.01, 0.5, 2 etc.)
+- `Min Points` [Required]: the minimum number of neighbors a point needs to have to be considered a core point (e.g.: 3, 5, 10 etc.)
+- `Names Similarity` [Optional]: Besides geographical proximity, the algorithm also considers the similarity between stop names using techniques like string similarity measures. This enhances the clustering by including stops with similar names within the same cluster (e.g.: all values between 0 and 1. The more the value is in proximity of 1, the more similar the stop names need to be considered points of the same cluster). The default value is 1, so if you want to create clusters based only on stop positions, leave this to 0.
+- `Stop config file` (CSV file path) [Optional]: This file is specifically designed to handle certain cases where stop names need to be altered or mapped to different names before running the clustering algorithm. Each entry consists of two columns:
+**stop_name**: This column contains the original name of the stop that requires modification or mapping to another name. **cluster_name**: This column specifies the name to which the original stop name should be changed or mapped during the clustering process.
+
+It utilizes the [DBSCAN](https://en.wikipedia.org/wiki/DBSCAN) Density-Based algorithm to perform clustering. I based my core algorithm on the gem [Dbscan](https://github.com/matiasinsaurralde/dbscan)
+
+### Stops config file example
+
+Here is an example of a stops_config CSV file:
+
+```csv
+stop_name,cluster_name
+Stop Name To Be Changed,Actual Name
+Amargosa Valley (Demo),Amargosa Valley
+E Main St / S Irving St (Demo),E Main St / S Irving St
+```
+
+In this case, passing this CSV file to the clustering algorithm, **Amargosa Valley (Demo)** will be renamed **Amargarosa Valley**, and so on for all the entries provided. The reason why I needed to implement this feature is simply because I was dealing with bad stops names (typo) provided by default within the GTFS I was working on.
+
+## Requirements
+
+It is essential to have a **Redis server instance running locally (on default port 6379)** because the algorithm leverages Redis geospatial queries for efficient spatial operations.
+The Redis server is utilized to optimize geospatial queries, allowing the clustering algorithm to efficiently process proximity-related computations required during the clustering process.
+Please ensure that a Redis server is installed and running on your local machine to utilize the gem effectively.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+```ruby
+gem 'gtfs_stops_clustering', '~> 0.1.5'
+```
+And run the following command
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ bundle install
+```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ gem install gtfs_stops_clustering
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'gtfs_stops_clustering'
+include GtfsStopsClustering
+
+gtfs_paths = ["path/to/gtfs/zip"]
+
+clusters = build_clusters(gtfs_paths, 0.3, 1, 0.85)
+
+clusters.each do |index, cluster|
+  puts index
+  cluster.each do |stop|
+    puts stop.inspect
+  end
+end
+```
+
+In this case, I'm showing the output referred to the GTFS file located in `test/fixtures/sample-feed-2.zip` (which is the sample-feed provided by Google, but changed a bit in order to create "clusterable" stops since they all were too far to be clustered). In this case I omitted the optional parameter `stops config`
+
+```
+-1
+{:stop_id=>"4", :stop_code=>nil, :cluster_name=>nil, :cluster_pos=>[], :stop_name=>"Stagecoach Hotel & Casino (Demo)", :stop_lat=>"36.915682", :stop_lon=>"-116.751677", :parent_station=>nil}
+{:stop_id=>"6", :stop_code=>nil, :cluster_name=>nil, :cluster_pos=>[], :stop_name=>"Alone stop (sad)", :stop_lat=>"36.914944", :stop_lon=>"-116.761472", :parent_station=>nil}
+{:stop_id=>"8", :stop_code=>nil, :cluster_name=>nil, :cluster_pos=>[], :stop_name=>"E Main St / S Irving St (Demo)", :stop_lat=>"36.905697", :stop_lon=>"-116.76218", :parent_station=>nil}
+{:stop_id=>"9", :stop_code=>nil, :cluster_name=>nil, :cluster_pos=>[], :stop_name=>"Amargosa Valley (Demo)", :stop_lat=>"36.641496", :stop_lon=>"-116.40094", :parent_station=>nil}
+0
+{:stop_id=>"1", :stop_code=>nil, :cluster_name=>"Awesome Stop Name", :cluster_pos=>[36.425286, -117.133156], :stop_name=>"Awesome stop name 1", :stop_lat=>"36.425288", :stop_lon=>"-117.133162", :parent_station=>nil}
+{:stop_id=>"5", :stop_code=>nil, :cluster_name=>"Awesome Stop Name", :cluster_pos=>[36.425286, -117.133156], :stop_name=>"Awesome stop name 2", :stop_lat=>"36.425284", :stop_lon=>"-117.133150", :parent_station=>nil}
+1
+{:stop_id=>"2", :stop_code=>nil, :cluster_name=>"Nye County Airport", :cluster_pos=>[36.868429, -116.78467699999999], :stop_name=>"Nye County Airport A1", :stop_lat=>"36.868446", :stop_lon=>"-116.784582", :parent_station=>nil}
+{:stop_id=>"3", :stop_code=>nil, :cluster_name=>"Nye County Airport", :cluster_pos=>[36.868429, -116.78467699999999], :stop_name=>"Nye County Airport A2", :stop_lat=>"36.868417", :stop_lon=>"-116.784352", :parent_station=>nil}
+{:stop_id=>"7", :stop_code=>nil, :cluster_name=>"Nye County Airport", :cluster_pos=>[36.868429, -116.78467699999999], :stop_name=>"Nye County Airport A5", :stop_lat=>"36.868424", :stop_lon=>"-116.785097", :parent_station=>nil}
+```
 
 ## Development
 

data/lib/gtfs_stops_clustering/redis_geodata.rb

@@ -22,6 +22,7 @@ module RedisGeodata
       @key = "stops"
       @epsilon = epsilon
       geoadd
+      ObjectSpace.define_finalizer(self, proc { @redis.del(@key) })
     end
 
     def geoadd

data/lib/gtfs_stops_clustering/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GtfsStopsClustering
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

data/lib/gtfs_stops_clustering.rb

@@ -61,6 +61,7 @@ module GtfsStopsClustering
       @clusters.each_value do |cluster|
         cluster.each do |stop|
           gtfs_stop = @gtfs_stops.find { |e| e.lat == stop[:stop_lat] && e.lon == stop[:stop_lon] }
+          stop[:stop_name] = gtfs_stop.name
           stop[:stop_id] = gtfs_stop.id
           stop[:stop_code] = gtfs_stop.code
           stop[:parent_station] = gtfs_stop.parent_station

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gtfs_stops_clustering
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Pietro Visconti
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2023-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv