Merge pull request #192 from InsightLab/developer

Developer

Author: mxaviersmp

.code-style.md

@@ -13,7 +13,6 @@ We are using some tools to keep a default coding style in the project.
 
 We following the [Numpy](https://numpydoc.readthedocs.io/en/latest/format.html) docstring style with [PEP484](https://www.python.org/dev/peps/pep-0484/#abstract).
 
-
 ## Links
 -   <https://pre-commit.com/>
 -   <https://www.codacy.com/>

.github/workflows/code_coverage.yml

@@ -18,10 +18,10 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pytest coverage geopandas .
+        make dev
     - name: Coverage
       run: |
-        coverage run -m pytest
+        make coverage
         coverage xml -o "coverage.xml"
     - name: Codacy Coverage Reporter
       uses: codacy/codacy-coverage-reporter-action@master

.github/workflows/lint_and_test.yml

@@ -14,11 +14,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pep8-naming .
+        make dev
     - name: Lint
       working-directory: ${{ github.workspace }}
       run: |
-        flake8
+        make lint
   test:
     name: Code Testing
     runs-on: ubuntu-latest
@@ -31,8 +31,8 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install pytest geopandas .
+        make dev
     - name: Test
       working-directory: ${{ github.workspace }}
       run: |
-        pytest --verbose
+        make test

.github/workflows/publish.yml

@@ -18,11 +18,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install flake8 pep8-naming pytest geopandas .
+        make dev
     - name: Lint and Test
       run: |
-        flake8
-        pytest
+        make lint
+        make test
     - name: Build
       run: |
         pip install setuptools wheel twine

.gitignore

@@ -339,9 +339,9 @@ $RECYCLE.BIN/
 # Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
 
 developing/
-examples/*
-!examples/geolife_sample.csv
-!examples/atlantic.csv
-!examples/README.md
-!examples/[0-9]*.ipynb
-!examples/extracao_geolife.ipynb
+notebooks/*
+!notebooks/geolife_sample.csv
+!notebooks/atlantic.csv
+!notebooks/README.md
+!notebooks/[0-9]*.ipynb
+!notebooks/extracao_geolife.ipynb

.mapping.png

@@ -7,7 +7,7 @@ version: 2
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-  configuration: docs/conf.py
+  configuration: ./docs/conf.py
 
 # Optionally build your docs in additional formats such as PDF
 formats:
@@ -17,4 +17,6 @@ formats:
 python:
   version: 3.7
   install:
-    - requirements: requirements-dev.txt
+    - requirements: ./docs/requirements.txt
+    - method: pip
+      path: .

.readthedocs.yml

@@ -1,4 +1,5 @@
 include requirements.txt
 include LICENSE
 include README.md
+include .mapping.png
 include pymove/tests/baseline/*.png

MANIFEST.in

@@ -8,6 +8,7 @@ help:
 
 dev:
 	pip install -r requirements-dev.txt
+	pip install -e .
 	pre-commit install
 
 clean:
@@ -18,14 +19,19 @@ clean:
 	rm -f .coverage
 
 test: clean
+	pytest
+
+coverage: clean
 	coverage run -m pytest
 	coverage report
 
 lint: clean
 	flake8
 
 docs: clean
+	cp docs/examples/notebooks.rst docs
 	rm -rf docs/api docs/examples
 	sphinx-apidoc -f -o docs/api pymove pymove/tests/
-	jupyter nbconvert --to rst --output-dir docs/examples examples/[0-9]*.ipynb
+	jupyter nbconvert --to rst --output-dir docs/examples notebooks/[0-9]*.ipynb
+	mv docs/notebooks.rst docs/examples
 	make -C docs html

Makefile

@@ -29,14 +29,6 @@
     </a>
 </td>
 </tr>
-<tr>
-  <td>Build Status</td>
-  <td>
-    <a href="https://travis-ci.org/InsightLab/PyMove/">
-      <img src="https://img.shields.io/travis/InsightLab/pymove/master?style=for-the-badge" alt="Travis build status" />
-    </a>
-  </td>
-</tr>
 <tr>
   <td>Platforms</td>
   <td>
@@ -169,15 +161,15 @@ Requirements: Anaconda Python distribution installed and accessible
  you want to call your environment, and replace `x.x` with the Python version
  you wish to use. (To see a list of available python versions first,
  type conda search "^python$" and press enter.)
-    -   `conda create -n <env_name> python=x.x`
+    -   ``conda create -n <env_name> python=x.x``
 
-    -   Press y to proceed. This will install the Python version and all the
+    -   `Press y to proceed. This will install the Python version and all the`
  associated anaconda packaged libraries at `path_to_your_anaconda_location/anaconda/envs/env_name`
 
 2.  Activate your virtual environment. To activate or switch into your
  virtual environment, simply type the following where yourenvname is the
  name you gave to your environment at creation.
-    -   `conda activate <env_name>`
+    -   ``conda activate <env_name>``
 
 3.  Now install the package from either `conda`, `pip` or `github`
 
@@ -196,19 +188,19 @@ Requirements: Anaconda Python distribution installed and accessible
 ## [Github](https://github.com/InsightLab/PyMove) installation
 
 1.  Clone this repository
-    -   `git clone https://github.com/InsightLab/PyMove`
+    -   ``git clone https://github.com/InsightLab/PyMove``
 
 2.  Switch to folder PyMove
-    -   `cd PyMove`
+    -   ``cd PyMove``
 
 3.  Switch to a new branch
-    -   `git checkout -b developer`
+    -   ``git checkout -b developer``
 
 4.  Make a pull of branch
-    -   `git pull origin developer`
+    -   ``git pull origin developer``
 
 5.  Install pymove in developer mode
-    -   `make dev`
+    -   ``make dev``
 
 ### For windows users
 
@@ -219,12 +211,115 @@ If you installed from `pip` or `github`, you may encounter an error related to
 
 ## Examples
 
-You can access examples of how to use PyMove [here](https://github.com/InsightLab/PyMove/tree/master/examples)
+You can see examples of how to use PyMove [here](https://github.com/InsightLab/PyMove/tree/master/notebooks)
+
+---
+
+## Mapping PyMove methods with the Paradigms of Trajectory Data Mining
+
+![](.mapping.png)
+[ZHENG 2015](https://www.microsoft.com/en-us/research/publication/trajectory-data-mining-an-overview/).
+
+-   1: **Spatial Trajectories** &rarr; `pymove.core`
+    -   `MoveDataFrame`
+    -   `DiscreteMoveDataFrame`
+
+-   2: **Stay Point Detection** &rarr; `pymove.preprocessing.stay_point_detection`
+    -   `create_or_update_move_stop_by_dist_time`
+    -   `create_or_update_move_and_stop_by_radius`
+
+-   3: **Map-Matching** &rarr; `pymove-osmnx`
+
+-   4: **Noise Filtering** &rarr; `pymove.preprocessing.filters`
+    -   `by_bbox`
+    -   `by_datetime`
+    -   `by_label`
+    -   `by_id`
+    -   `by_tid`
+    -   `clean_consecutive_duplicates`
+    -   `clean_gps_jumps_by_distance`
+    -   `clean_gps_nearby_points_by_distances`
+    -   `clean_gps_nearby_points_by_speed`
+    -   `clean_gps_speed_max_radius`
+    -   `clean_trajectories_with_few_points`
+    -   `clean_trajectories_short_and_few_points`
+    -   `clean_id_by_time_max`
+
+-   5: **Compression** &rarr; `pymove.preprocessing.compression`
+    -   `compress_segment_stop_to_point`
+
+-   6: **Segmentation** &rarr; `pymove.preprocessing.segmentation`
+    -   `bbox_split`
+    -   `by_dist_time_speed`
+    -   `by_max_dist`
+    -   `by_max_time`
+    -   `by_max_speed`
+
+-   7: **Distance of Trajectory** &rarr; `pymove.query.query`
+    -   `range_query`
+    -   `knn_query`
+
+-   8: **Query Historical Trajectories**
+
+-   9: **Managing Recent Trajectories**
+
+-   10: **Privacy Preserving**
+
+-   11: **Reducing Uncertainty**
+
+-   12: **Moving Together Patterns**
+
+-   13: **Clustering** &rarr; `pymove.models.pattern_mining.clustering`
+    -   `elbow_method`
+    -   `gap_statistics`
+    -   `dbscan_clustering`
+
+-   14: **Freq. Seq. Patterns**
+
+-   15: **Periodic Patterns**
+
+-   16: **Trajectory Classification**
+
+-   17: **Trajectory Outlier / Anomaly Detection** &rarr; `pymove.semantic.semantic`
+    -   `outliers`
+    -   `create_or_update_out_of_the_bbox`
+    -   `create_or_update_gps_deactivated_signal`
+    -   `create_or_update_gps_jump`
+    -   `create_or_update_short_trajectory`
+    -   `create_or_update_gps_block_signal`
+    -   `filter_block_signal_by_repeated_amount_of_points`
+    -   `filter_block_signal_by_time`
+    -   `filter_longer_time_to_stop_segment_by_id`
+
+---
+
+## Cite
+
+The library was originally created during the bachelor's thesis of 2 students from the Federal University of Ceará, so you can cite using both works.
+
+```txt
+@mastersthesis{arina2019,
+	title        = {Uma Arquitetura E Implementação Do Módulo De Pré-processamento Para Biblioteca Pymove},
+	author       = {Arina De Jesus Amador Monteiro Sanches},
+	year         = 2019,
+	school       = {Universidade Federal Do Ceará},
+	type         = {Bachelor's thesis}
+}
+@mastersthesis{andreza2019,
+	title        = {Uma Arquitetura E Implementação Do Módulo De Visualizaçãopara Biblioteca Pymove},
+	author       = {Andreza Fernandes De Oliveira},
+	year         = 2019,
+	school       = {Universidade Federal Do Ceará},
+	type         = {Bachelor's thesis}
+}
+```
+
 ---
 
-## Papers
+## Publications
 
-(list of publications using/with Pymove)
+-   [Uma Arquitetura E Implementação Do Módulo De Pré-processamento Para Biblioteca Pymove](http://repositorio.ufc.br/handle/riufc/58551)
+-   [Uma Arquitetura E Implementação Do Módulo De Visualizaçãopara Biblioteca Pymove](http://repositorio.ufc.br/handle/riufc/58550)
 
 ---