Skip to content

Commit 53df166

Browse files
authored
Update and rename README.txt to README.md
1 parent e4b1ddb commit 53df166

File tree

2 files changed

+29
-18
lines changed

2 files changed

+29
-18
lines changed

README.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Bicing Station Optimization Project
2+
3+
## Project Overview
4+
This project aims to optimize the distribution of bicycles across bicing stations in a city to meet expected demand using local search algorithms, specifically Hill Climbing and Simulated Annealing. The goal is to minimize transportation costs while ensuring that all possible bicycles are moved according to predictions for each station.
5+
6+
## Setup Instructions
7+
8+
### Prerequisites
9+
- Python 3.x
10+
- Pygame (for route visualization)
11+
- The `abia_bicing.py` file (containing `Estacion` and `Estaciones` classes) must be in the same folder as `main.py`.
12+
13+
### Running Experiments
14+
1. Open `main.py`. This file contains the main logic for executing experiments.
15+
2. Starting from line 70, you'll find commented-out function calls for experiment execution, formatted as `experimentoX()`, where X is the experiment number.
16+
3. To run an experiment, uncomment the desired function call. Make sure to leave other lines (variable declarations, etc.) as they are, since they contain experiment results and parameters used in other experiments.
17+
4. For Experiment 5, execute it twice, once for each heuristic:
18+
- Open `parameters_bicing.py`.
19+
- Modify the `params` object's `coste_transporte` parameter to `False` for heuristic 1 or `True` for heuristic 2.
20+
21+
### Individual Algorithm Execution
22+
After completing the experiments, you can run individual instances of the Hill Climbing algorithm with a single replica to observe the route visualization in Pygame and check the `__repr__()/__str__()` outputs for both the initial and final states.
23+
- To switch heuristics for any run, adjust the `coste_transporte` parameter in `parameters_bicing.py` as mentioned above.
24+
25+
## Visualization
26+
Utilize Pygame to visualize the routes and distributions created by the algorithms, providing an interactive way to observe the optimization process in action.
27+
28+
## Contributions
29+
This project showcases the application of local search algorithms to real-world logistics and urban planning problems, demonstrating the potential of AI in improving city services and infrastructure.

README.txt

-18
This file was deleted.

0 commit comments

Comments
 (0)