diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca91701..709dbf7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,12 +9,12 @@ MobilityDB uses DocBook v4.5 to generate workshop guides. The instructions below ## Contribution Workflow Steps are as follows: -- Usually, the latest version of the workshop guide is in the `develop` branch. Refer always to this branch. +- The latest version of the workshop guide is in the `master` branch. Refer always to this branch. - Fork the repository and clone it locally. -- Create a new branch from `develop` and name it `feature/`. For example, 'feature/correcting_typos'. +- Create a new branch from `master` and name it `feature/`. For example, 'feature/correcting_typos'. - Make your changes and commit them to your branch. - Push your branch to your forked repository. -- Create a pull request from your branch to the `develop` branch of the main repository. Please, make sure to detail your changes in the pull request description. A nice way to do this is to use the following template: +- Create a pull request from your branch to the `master` branch of the main repository. Please, make sure to detail your changes in the pull request description. A nice way to do this is to use the following template: ```markdown Changes: diff --git a/README.md b/README.md index e6910af..4658906 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ You can generate the workshop documentation from the sources. Go to `/docs` dire ```bash dbtoepub -o mobilitydb-workshop.epub mobilitydb-workshop.xml ``` -In addition, pregenerated versions of them are available for both the master and develop branches. +In addition, pregenerated versions of them are available for the master branch. -* HTML: [master](https://mobilitydb.github.io/MobilityDB-workshop/master/html/index.html), [develop](https://mobilitydb.github.io/MobilityDB-workshop/develop/html/index.html) -* PDF: [master](https://mobilitydb.github.io/MobilityDB-workshop/master/mobilitydb-manual.pdf), [develop](https://mobilitydb.github.io/MobilityDB-workshop/develop/mobilitydb-manual.pdf) -* EPUB: [master](https://mobilitydb.github.io/MobilityDB-workshop/master/mobilitydb-manual.epub), [develop](https://mobilitydb.github.io/MobilityDB-workshop/develop/mobilitydb-manual.epub) +* HTML: [master](https://mobilitydb.github.io/MobilityDB-workshop/master/html/index.html) +* PDF: [master](https://mobilitydb.github.io/MobilityDB-workshop/master/mobilitydb-workshop.pdf) +* EPUB: [master](https://mobilitydb.github.io/MobilityDB-workshop/master/mobilitydb-workshop.epub) ## How the Repo is Organized - `/data`: raw data files used for some workshops diff --git a/docs/GTFS.xml b/docs/GTFS.xml index 7974973..3df94b6 100644 --- a/docs/GTFS.xml +++ b/docs/GTFS.xml @@ -4,14 +4,14 @@ The General Transit Feed Specification (GTFS) defines a common format for public transportation schedules and associated geographic information. GTFS-realtime is used to specify real-time transit data. Many transportation agencies around the world publish their data in GTFS and GTFS-realtime format and make them publicly available. A well-known repository containing such data is OpenMobilityData. - In this chapter, we illustrate how to load GTFS data in MobilityDB. For this, we first need to import the GTFS data into PostgreSQL and then transform this data so that it can be loaded into MobilityDB. The data used in this tutorial is obtained from STIB-MIVB, the Brussels public transportation company and is available as a ZIP file. You must be aware that GTFS data is typically of big size. In order to reduce the size of the dataset, this file only contains schedules for one week and five transportation lines, whereas typical GTFS data published by STIB-MIVB contains schedules for one month and 99 transportation lines. In the reduced dataset used in this tutorial the final table containing the GTFS data in MobilityDB format has almost 10,000 trips and its size is 241 MB. Furtheremore, we need several temporary tables to transform GTFS format into MobilityDB and these tables are also big, the largest one has almost 6 million rows and its size is 621 MB. + In this chapter, we illustrate how to load GTFS data in MobilityDB. For this, we first need to import the GTFS data into PostgreSQL and then transform this data so that it can be loaded into MobilityDB. The data used in this tutorial is obtained from STIB-MIVB, the Brussels public transportation company and is available as a ZIP file. You must be aware that GTFS data is typically of big size. In order to reduce the size of the dataset, this file only contains schedules for one week and five transportation lines, whereas typical GTFS data published by STIB-MIVB contains schedules for one month and 99 transportation lines. In the reduced dataset used in this tutorial the final table containing the GTFS data in MobilityDB format has almost 10,000 trips and its size is 241 MB. Furtheremore, we need several temporary tables to transform GTFS format into MobilityDB and these tables are also big, the largest one has almost 6 million rows and its size is 621 MB. Several tools can be used to import GTFS data into PostgreSQL. For example, one publicly available in Github can be found here. These tools load GTFS data into PostgreSQL tables, allowing one to perform multiple imports of data provided by the same agency covering different time frames, perform various complex tasks including data validation, and take into account variations of the format provided by different agencies, updates of route information among multiple imports, etc. For the purpose of this tutorial we do a simple import and transformation using only SQL. This is enough for loading the data set we are using but a much more robust solution should be used in an operational environment, if only for coping with the considerable size of typical GTFS data, which would require parallelization of this task. Loading GTFS Data in PostgreSQL - The ZIP file with the data for this tutorial contains a set of CSV files (with extension .txt) as follows: + The ZIP file with the data for this tutorial contains a set of CSV files (with extension .txt) as follows: agency.txt contains the description of the transportation agencies provinding the services (a single one in our case). diff --git a/docs/mobilitydb-workshop.xml b/docs/mobilitydb-workshop.xml index 73805fa..41d9c62 100644 --- a/docs/mobilitydb-workshop.xml +++ b/docs/mobilitydb-workshop.xml @@ -63,7 +63,7 @@ Every module in this workshop illustrates a usage scenario of MobilityDB. The data sets and the tools are described inside each of the modules. Eventually, additional modules will be added to discover more MobilityDB features. - While this workshop illustrates the usage of MobilityDB functions, it does not explain them in detail. If you need help concerning the functions of MobilityDB, please refer to the documentation. + While this workshop illustrates the usage of MobilityDB functions, it does not explain them in detail. If you need help concerning the functions of MobilityDB, please refer to the documentation. If you have questions, ideas, comments, etc., please contact me on mahmoud.sakr@ulb.ac.be.