w1ndrunn3rr/poland_map_project

A project using an A* algorithm, to search the shorthest path for City A to City B in Poland, based on self-created database in JSON format. Project written in Python 3.

SPECYFIKACJA PROGRAMU

OPIS PROGRAMU

Program służy do wyszukiwania najkrótszych lub najszybszych połączeń drogowych pomiędzy polskimi miastami, za pomocą algorytmu A* z funkcją heurystyczną haversine na grafie osadzonym na liście sąsiedztwa lub macierzy sąsiedztwa. Wyszukiwanie odbywa się w zakresie danych znajdujących się w folderze /data w pliku mapa_polski.json, ale jest możliwe także uruchomienie aplikacji, jeżeli plik jest w formacie JSON oraz posiada dokładnie taki sam układ.

Program realizuje obsługę interfejsową - prosty program napisany za pomocą modułu tkinter oraz modułu tkintermapview https://github.com/TomSchimansky/TkinterMapView.

A także realizuje obsługę bez interfejsu w terminalu.

WYMAGANIA

Projekt wymaga Pythona w wersji 3.9 lub wyższej oraz należy mieć poprawnie skonfigurowany instalator paczek Pythona - pip oraz virtual venv, który jest domyślnie dołączany do Pythona. Jeśli jednak by go nie było należy go zainstalować :

pip install virtualenv

TWORZENIE ŚRODOWISKA WIRTUALNEGO

1.Aby uruchomić program należy stworzyć środowisko wirtualne Python venv https://docs.python.org/3/library/venv.html. Aby to zrobić należy być w folderze docelowym i wpisać w konsoli :

python -m venv .venv

lub

python3 -m venv .venv

Utworzy to w folderze docelowym wirtualne środowisko Pythona w folderze .venv.

2.Następnie należy aktywować środowisko w bashu :

source .venv/bin/activate

3.Teraz aby zainstalować potrzebne paczki projektowe należy uruchomić polecenie :

pip install -r requirements.txt

4.Środowisko jest gotowe; w celu jego opuszczenia należy wpisać w terminal :

deactivate

URUCHOMIENIE PROGRAMU

W celu skorzystania z programu należy uruchomić skrypt main.py w utworzonym wcześniej. Aby poprawnie wywołać skrypt z użyciem GUI, należy zastosować następującą składnię :

python main.py

lub

python3 main.py

W tym wariancie wyświetlania użytkownik ma do dyspozycji dwa pola tekstowe do wpisywania pełnych nazw miast. W momencie wpisania chociaż jednej litery, użytkownik może nacisnąć klawisz TAB, aby nastąpiło autouzupełnienie miejscowością o podanej składni (uzupełnienie następuje raz). Można także pisać nazwy bez polskich znaków i z małych bądź dużych liter np. JANÓW (TAB) -> Janów Lubelski, zielona (TAB) -> Zielona Góra. Użytkownik może także wybrać 2 warianty drogi : najkrótsza i najszybsza oraz unikać połączeń autostradowych. Po naciśnięciu przycisku "Znajdź trasę", pojawi się komunikat o czasie przejazdu oraz drodze do pokonania. W momencie podania błednej nazwy chociaż jednego miasta lub braku połączeń, wyświetli się komunikat "Brak miasta w bazie / trasa nie istnieje"/

Aby poprawnie wywołać skrypt z użyciem argumentów (bez GUI), należy zastosować następującą składnię :

python main.py town1 town2 [ (LENGTH|TIME) [maxclass [minclass]] ]

lub

python3 main.py town1 town2 [ (LENGTH|TIME) [maxclass [minclass]] ]

• town1 - identyfikator miasta 1 (np. name = Nowy Sącz -> id = NowySacz)

• town2 - identfikator miasta 2 ( wymagany przy podaniu town1 )

• (LENGTH|TIME) - wybór trybu algorytmu :

  • LENGTH - algorytm optymalizuje długość drogi ;
  • TIME - algorytm optymalizuje czas przejazdu drogi

• maxclass - maksymalna klasa drogi jaką algorytm bierze pod uwagę (liczba nieujemna)

• minclass - minimalna klasa drogi jaką algorytm bierze pod uwagę (liczba nieujemna)

Oznaczenia klas dróg:

• 5 - autostrada
• 4 - droga szybkiego ruchu
• 3 - droga krajowa
• 2 - droga powiatowa
• 1 - połączenie promowe
• 0 - dowolna

W takim trybie w terminalu pojawi się wynik w postaci :

miasta_połączenia długość/czas ilość_odwiedzonych_węzłów 

Jeżeli połączenie nie zostanie znalezionie, albo miasta nie będzie w bazie to wtedy wterminalu pojawi się :

NOTFOUND ilość_odwiedzonych_węzłów 

Uruchomienie komendy :

python3 main.py -h

Pokazuje jak użyć argumentów

Autor Jakub Gilewicz 275409

Województwa podkarpackie i lubelskie zostały stworzone przeze mnie.