alexander/urban-meal-delivery
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions
urban-meal-delivery/README.md

62 lines
2.3 KiB
Markdown
Raw Normal View History

Initial commit - add the following files: + .gitignore => ignore poetry's and pyenv's artifacts + LICENSE.txt => MIT license as the project is scientific research + README.md => rough description of the project + poetry.lock + pyproject.toml + src/urban_meal_delivery/__init__.py => source code package - use a "src" layout structure: + ensure that pytest runs the tests against a packaged and pip installed version of the source code, not the *.py files in the project directory + more info: https://hynek.me/articles/testing-packaging/
2020-08-03 20:19:42 +02:00
# Urban Meal Delivery
This repository holds code
Add info about the data cleaning
2020-09-30 13:43:00 +02:00
analyzing the data of an undisclosed urban meal delivery platform (UDP)
Initial commit - add the following files: + .gitignore => ignore poetry's and pyenv's artifacts + LICENSE.txt => MIT license as the project is scientific research + README.md => rough description of the project + poetry.lock + pyproject.toml + src/urban_meal_delivery/__init__.py => source code package - use a "src" layout structure: + ensure that pytest runs the tests against a packaged and pip installed version of the source code, not the *.py files in the project directory + more info: https://hynek.me/articles/testing-packaging/
2020-08-03 20:19:42 +02:00
operating in France from January 2016 to January 2017.
The goal is to
optimize the platform's delivery process involving independent couriers.
Add installation and contributing info
2020-08-11 11:02:09 +02:00
## Structure
Add info about the data cleaning
2020-09-30 13:43:00 +02:00
The analysis is structured into the following stages
Initial commit - add the following files: + .gitignore => ignore poetry's and pyenv's artifacts + LICENSE.txt => MIT license as the project is scientific research + README.md => rough description of the project + poetry.lock + pyproject.toml + src/urban_meal_delivery/__init__.py => source code package - use a "src" layout structure: + ensure that pytest runs the tests against a packaged and pip installed version of the source code, not the *.py files in the project directory + more info: https://hynek.me/articles/testing-packaging/
2020-08-03 20:19:42 +02:00
that iteratively build on each other.
Add info about the data cleaning
2020-09-30 13:43:00 +02:00
### Data Cleaning
The UDP provided its raw data as a PostgreSQL dump.
Merge branch 'research-clean-data' into develop
2020-09-30 13:51:09 +02:00
This [notebook](https://nbviewer.jupyter.org/github/webartifex/urban-meal-delivery/blob/develop/notebooks/00_clean_data.ipynb)
Add info about the data cleaning
2020-09-30 13:43:00 +02:00
cleans the data extensively
Merge branch 'research-clean-data' into develop
2020-09-30 13:51:09 +02:00
and maps them onto the [ORM models](https://github.com/webartifex/urban-meal-delivery/tree/develop/src/urban_meal_delivery/db)
Add info about the data cleaning
2020-09-30 13:43:00 +02:00
defined in the `urban-meal-delivery` package
Merge branch 'research-clean-data' into develop
2020-09-30 13:51:09 +02:00
that is developed in the [src/](https://github.com/webartifex/urban-meal-delivery/tree/develop/src) folder
Add info about the data cleaning
2020-09-30 13:43:00 +02:00
and contains all source code to drive the analyses.
Due to a non-disclosure agreement with the UDP,
neither the raw nor the cleaned data are published as of now.
Merge branch 'research-clean-data' into develop
2020-09-30 13:51:09 +02:00
However, previews of the data can be seen throughout the [notebooks/](https://github.com/webartifex/urban-meal-delivery/tree/develop/notebooks) folders.
Add info about the data cleaning
2020-09-30 13:43:00 +02:00
Add installation and contributing info
2020-08-11 11:02:09 +02:00
### Real-time Demand Forecasting
### Predictive Routing
### Shift & Capacity Planning
## Installation & Contribution
To play with the code developed for the analyses,
you can clone the project with [git](https://git-scm.com/)
and install the contained `urban-meal-delivery` package
and all its dependencies
in a [virtual environment](https://docs.python.org/3/tutorial/venv.html)
with [poetry](https://python-poetry.org/docs/):
`git clone https://github.com/webartifex/urban-meal-delivery.git`
and
`poetry install --extras research`
Initial commit - add the following files: + .gitignore => ignore poetry's and pyenv's artifacts + LICENSE.txt => MIT license as the project is scientific research + README.md => rough description of the project + poetry.lock + pyproject.toml + src/urban_meal_delivery/__init__.py => source code package - use a "src" layout structure: + ensure that pytest runs the tests against a packaged and pip installed version of the source code, not the *.py files in the project directory + more info: https://hynek.me/articles/testing-packaging/
2020-08-03 20:19:42 +02:00
Add installation and contributing info
2020-08-11 11:02:09 +02:00
The `--extras` option is necessary as the non-develop dependencies
are structured in the [pyproject.toml](https://github.com/webartifex/urban-meal-delivery/blob/develop/pyproject.toml) file
into dependencies related to only the `urban-meal-delivery` source code package
and dependencies used to run the [Jupyter](https://jupyter.org/) environment
with the analyses.
Initial commit - add the following files: + .gitignore => ignore poetry's and pyenv's artifacts + LICENSE.txt => MIT license as the project is scientific research + README.md => rough description of the project + poetry.lock + pyproject.toml + src/urban_meal_delivery/__init__.py => source code package - use a "src" layout structure: + ensure that pytest runs the tests against a packaged and pip installed version of the source code, not the *.py files in the project directory + more info: https://hynek.me/articles/testing-packaging/
2020-08-03 20:19:42 +02:00
Add installation and contributing info
2020-08-11 11:02:09 +02:00
Contributions are welcome.
Use the [issues](https://github.com/webartifex/urban-meal-delivery/issues) tab.
The project is licensed under the [MIT license](https://github.com/webartifex/urban-meal-delivery/blob/develop/LICENSE.txt).
Reference in a new issue Copy permalink