Skip to content

Notebooks examples #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Notebooks examples #238

wants to merge 12 commits into from

Conversation

MarcelGeo
Copy link
Contributor

@MarcelGeo MarcelGeo commented May 28, 2025

  • introduce examples using python notebooks

  • 2 scenarios are ready to check if there is everything fine

    1. scenario - Team management
    1. scenario - Synchronization
    1. scenario (Project management)

@fernandinand
Copy link

@alex-cit Can you have a review on this?

Copy link
Contributor

@wonder-sk wonder-sk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff! Looking forward for more 😉

@coveralls
Copy link

Pull Request Test Coverage Report for Build 15611326043

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 80.019%

Totals Coverage Status
Change from base Build 15386659816: 0.0%
Covered Lines: 3380
Relevant Lines: 4224

💛 - Coveralls

Copy link

@alex-cit alex-cit left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, guys!

I have left some suggestions related to US/UK spelling (synchronize vs. synchronise, we use UK spelling in the docs), unified use of GeoPackage (vs. geopackage) and use of product names (Mergin Maps mobile app instead of Mergin Maps mobile application).

"id": "400194dc",
"metadata": {},
"source": [
"We can now add sample points from the `.csv` file to the GeoPackage. These points within the GeoPackage will then be available to surveyors in the field for editing the health column using the Mergin Maps mobile application."

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"We can now add sample points from the `.csv` file to the GeoPackage. These points within the GeoPackage will then be available to surveyors in the field for editing the health column using the Mergin Maps mobile application."
"We can now add sample points from the `.csv` file to the GeoPackage. These points within the GeoPackage will then be available to surveyors in the field for editing the health column using the Mergin Maps mobile app."

"id": "e65bb7c9",
"metadata": {},
"source": [
"Mobile application users are now enabled to perform updates to the imported tree data directly in the field.\n",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Mobile application users are now enabled to perform updates to the imported tree data directly in the field.\n",
"Mobile app users are now enabled to perform updates to the imported tree data directly in the field.\n",

"id": "75b88a5e-efc3-4569-a15e-6f49c591180f",
"metadata": {},
"source": [
"Download locally your newly created Mergin Maps project to add prepare data for your teams (Team A and Team B)."

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Download locally your newly created Mergin Maps project to add prepare data for your teams (Team A and Team B)."
"Download your newly created Mergin Maps project to prepare data for your teams (Team A and Team B)."

"id": "5ffce828",
"metadata": {},
"source": [
"Created users do not have any permissions now. Let's add users as collaborators to the projects. They will be able to start the survey with Mergin Maps mobile application."

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Created users do not have any permissions now. Let's add users as collaborators to the projects. They will be able to start the survey with Mergin Maps mobile application."
"Created users do not have any permissions yet. Let's add users as collaborators to the projects. They will be able to start the survey with Mergin Maps mobile app."

On this scenario you'll create some random users from an existing CSV into Mergin Maps, change user's `ROLE` on a `WORKSPACE` and `PROJECT` perspective as well remove user's from a specific project.

## [Scenario 2](02_sync.ipynb) - Synchronization
On this scenario you'll learn on how to do basic synchronization (`PUSH`, `PULL`) of projects with the Mergin Maps Python API client.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On this scenario you'll learn on how to do basic synchronization (`PUSH`, `PULL`) of projects with the Mergin Maps Python API client.
On this scenario you'll learn on how to do basic synchronisation (`PUSH`, `PULL`) of projects with the Mergin Maps Python API client.

"source": [
"Mergin Maps API allows you to manage your projects in a simple and effective way. See the [API reference](https://merginmaps.com/docs/dev/integration/) for more details about methods used in this notebook.\n",
"\n",
"First let's install mergin maps client (if not installed yet)"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"First let's install mergin maps client (if not installed yet)"
"First let's install Mergin Maps client (if not installed yet)"

"id": "10ea77c1-98b7-4d22-ac2c-a2b051db400e",
"metadata": {},
"source": [
"Let's add 20 trees to the geopackage for each team. See geopackages prepared for this example in the [./03_projects_assets](./03_projects_assets) folder."

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Let's add 20 trees to the geopackage for each team. See geopackages prepared for this example in the [./03_projects_assets](./03_projects_assets) folder."
"Let's add 20 trees to the GeoPackage for each team. See GeoPackages prepared for this example in the [./03_projects_assets](./03_projects_assets) folder."

}
],
"source": [
"# copy geopackage for team A to .gpkg file in LOCAL_FOLDER_TEAM_A\n",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"# copy geopackage for team A to .gpkg file in LOCAL_FOLDER_TEAM_A\n",
"# copy GeoPackage for team A to .gpkg file in LOCAL_FOLDER_TEAM_A\n",

" f\"./03_projects_assets/Ready_to_survey_trees_team_A.gpkg\",\n",
" f\"{LOCAL_FOLDER_TEAM_A}/Ready_to_survey_trees.gpkg\"\n",
")\n",
"# copy geopackage for team B to .gpkg file in LOCAL_FOLDER_TEAM_B\n",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"# copy geopackage for team B to .gpkg file in LOCAL_FOLDER_TEAM_B\n",
"# copy GeoPackage for team B to .gpkg file in LOCAL_FOLDER_TEAM_B\n",

"id": "a53d4a66",
"metadata": {},
"source": [
"Let's sync your changes with Mergin Maps."

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Let's sync your changes with Mergin Maps."
"Let's sync your changes to Mergin Maps."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants