Mobilkit

Mobilkit: A Python Toolkit for Urban Resilience and Disaster Risk Management Analytics - Published in JOSS (2024)

https://github.com/mindearth/mobilkit

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README and JOSS metadata
  • Academic publication links
  • Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Scientific Fields

Political Science Social Sciences - 90% confidence
Mathematics Computer Science - 84% confidence
Artificial Intelligence and Machine Learning Computer Science - 83% confidence
Last synced: 4 months ago · JSON representation

Repository

A Python Toolkit for Urban Resilience and Disaster Risk Management Analytics using High Frequency Human Mobility Data

Basic Info
  • Host: GitHub
  • Owner: mindearth
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 297 MB
Statistics
  • Stars: 57
  • Watchers: 2
  • Forks: 11
  • Open Issues: 0
  • Releases: 7
Created over 4 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

GitHub release (latest by date) GitHub GitHub contributors Documentation Status

mobilkit

A Python Toolkit for Urban Resilience and Disaster Risk Management Analytics using High Frequency Human Mobility Data.

mobilkit provides a set of tools to analyze mobility traces to assess the users response to extreme events. Try mobilkit without installing it in a MyBinder notebook: Binder

Table of contents

  1. Documentation
  2. Collaborate with us
  3. Installation
  4. Tutorials
  5. Examples
  6. Citing
  7. Credits and contacts

Documentation

Full documentation with examples can be found online here, otherwise see the notebooks in docs/examples for a step-by-step coverage of the library or the ones in examples/ for a more detailed showcase of the package's capabilities.

Collaborate with us

mobilkit is an active project and any contribution is welcome.

You are encouraged to report any issue or problem encountered while using the software or to seek for support.

If you would like to contribute or add functionalities to mobilkit, feel free to fork the project, open an issue and contact us.

Installation

Install with pip

Start by creating an environment and install mobilkit there.

  1. Create an environment mobilkit

    python3 -m venv mobilkit
    # or, on Windows
    python -m venv c:\path\to\mobilkit
    
  2. Activate

    source mobilkit/bin/activate
    # or, on Windows
    c:\path\to\mobilkit\Scripts\activate.bat
    
  3. Update pip

    pip install --upgrade pip
    
  4. Install mobilkit (this will also install Dask and all the needed modules)

    pip install mobilkit
    
  5. OPTIONAL to use mobilkit on the jupyter notebook

- Activate the virutalenv:

        source mobilkit/bin/activate

- Install jupyter notebook:

        pip install jupyter 

- Run jupyter notebook

        jupyter notebook

- (Optional) install the kernel with a specific name to your existing notebook server

        source mobilkit/bin/activate
        pip install ipykernel
        ipython kernel install --user --name=mobilkit_env

If you already have scikit-mobility installed, skip the environment creation and run these commands from the skmob anaconda environment.

mobilkit by default will only install core packages needed to run the main functions. There are three optional packages of dipendencies (the mobilkit[complete] installs everything): - [viz] will install contextily, needed to visualize map backgrounds in certain viz functions; - [doc] will install all the needed packages to build the docs; - [skmob] will install scikit-mobility as well; - [locations] will also install infostop to detect users' typical locations.

Install with conda

TODO

Test the installation

```

source activate mobilkit (mobilkit)> python

import mobilkit

```

Examples

Several notebooks are found in the docs/examples folder, we resume here the most important ones.

Quickstart

We show the basic usage and functionalities in the mobilkit_tutorial.ipynb notebook.

Citing

If you use mobilkit please cite us:

Enrico Ubaldi, Takahiro Yabe, Nicholas Jones, Maham Faisal Khan, Alessandra Feliciotti, Riccardo Di Clemente, Satish V. Ukkusuri and Emanuele Strano Mobilkit: A Python Toolkit for Urban Resilience and Disaster Risk Management Analytics using High Frequency Human Mobility Data, Journal of Open Source Software, 9, 95, 5201, (2024), Doi: 10.21105/joss.05201

Bibtex: @article{Ubaldi2024, doi = {10.21105/joss.05201}, url = {https://doi.org/10.21105/joss.05201}, year = {2024}, publisher = {The Open Journal}, volume = {9}, number = {95}, pages = {5201}, author = {Enrico Ubaldi and Takahiro Yabe and Nicholas Jones and Maham Faisal Khan and Alessandra Feliciotti and Riccardo Di Clemente and Satish V. Ukkusuri and Emanuele Strano}, title = {Mobilkit: A Python Toolkit for Urban Resilience and Disaster Risk Management Analytics}, journal = {Journal of Open Source Software}}

Credits and contacts

This code has been developed by Mindearth, the Global Facility for Disaster Reduction and Recovery (GFDRR) and Purdue University.

Funding was provided by the Spanish Fund for Latin America and the Caribbean (SFLAC) under the Disruptive Technologies for Development (DT4D) program.

The code is released under the MIT license (see the LICENSE file for details).

Owner

  • Name: MindEarth
  • Login: mindearth
  • Kind: organization
  • Location: Switzerland - Italy

JOSS Publication

Mobilkit: A Python Toolkit for Urban Resilience and Disaster Risk Management Analytics
Published
March 01, 2024
Volume 9, Issue 95, Page 5201
Authors
Enrico Ubaldi ORCID
MindEarth, Switzerland
Takahiro Yabe ORCID
Massachusetts Institute of Technology, USA
Nicholas Jones
The World Bank, USA
Maham Faisal Khan
The World Bank, USA
Alessandra Feliciotti ORCID
MindEarth, Switzerland
Riccardo Di Clemente ORCID
Complex Connections Lab, Network Science Institute, Northeastern University London, London, E1W 1LP, United Kingdom., The Alan Turing Institute, London, NW12DB, United Kingdom.
Satish V. Ukkusuri
Purdue University, USA
Emanuele Strano ORCID
MindEarth, Switzerland
Editor
Chris Vernon ORCID
Tags
mobile phone data disaster resilience human mobility geospatial analysis

GitHub Events

Total
  • Watch event: 9
  • Fork event: 1
Last Year
  • Watch event: 9
  • Fork event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 56
  • Total Committers: 7
  • Avg Commits per committer: 8.0
  • Development Distribution Score (DDS): 0.482
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Enrico Ubaldi e****i@m****h 29
MindEarth e****i@m****g 13
Enrico Ubaldi e****i@g****m 9
MindEarth 7****h 2
levisweetbreu l****t@v****u 1
Riccardo Di Clemente r****e@i****t 1
Olivia Guest o****t 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 7
  • Total pull requests: 12
  • Average time to close issues: about 2 months
  • Average time to close pull requests: about 24 hours
  • Total issue authors: 3
  • Total pull request authors: 5
  • Average comments per issue: 1.43
  • Average comments per pull request: 0.08
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • levisweetbreu (4)
  • ifthompson (2)
  • martinfleis (1)
Pull Request Authors
  • ubi15 (11)
  • oliviaguest (2)
  • ric-dicle (2)
  • levisweetbreu (1)
  • mindearth (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 33 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 1
pypi.org: mobilkit

A Python Toolkit for Urban Resilience and Disaster Risk Management Analytics using High Frequency Human Mobility Data

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 33 Last month
Rankings
Dependent packages count: 10.1%
Stargazers count: 11.6%
Forks count: 12.6%
Average: 14.8%
Downloads: 17.9%
Dependent repos count: 21.6%
Maintainers (1)
Last synced: 4 months ago

Dependencies

.github/workflows/draft-pdf.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite
.github/workflows/publish_pypi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
  • pypa/gh-action-pypi-publish release/v1 composite
Pipfile pypi
  • build *
  • click *
  • dask *
  • dcb7f3c *
  • descartes *
  • distributed *
  • fiona *
  • geojson *
  • geopandas *
  • haversine *
  • ipykernel *
  • joblib *
  • matplotlib *
  • pyarrow *
  • rtree *
  • scikit-learn *
  • scikit-mobility *
  • scipy *
  • seaborn *
  • wheel *