🚧 Initial Commit 🚧

.github/workflows/documentation.yml

@@ -0,0 +1,31 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+          architecture: "x64"
+      - name: Setup PDM
+        uses: pdm-project/setup-pdm@v4
+      - name: Install Dependencies
+        run: |
+          pip install -U .
+          pdm sync -d --only-keep -G doc
+      - name: Sphinx build
+        run: pdm run doc
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html/
+          force_orphan: true

.github/workflows/pypi-release.yml

@@ -0,0 +1,33 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      # This permission is needed for private repositories.
+      contents: read
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: pdm-project/setup-pdm@v3
+
+      - name: Publish package distributions to PyPI
+        run: pdm publish

.github/workflows/tests.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: pdm-project/setup-pdm@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: true
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade tox .
+      - name: Test with tox
+        run: |
+          tox --version
+          pyversion="${{ matrix.python-version }}"
+          tox -e py${pyversion/./}

.gitignore

@@ -0,0 +1,50 @@
+# Temporary and binary files
+*~
+*.py[cod]
+*.so
+*.cfg
+!.isort.cfg
+!setup.cfg
+*.orig
+*.log
+*.pot
+__pycache__
+__pypackages__
+.cache/*
+.*.swp
+.ipynb_checkpoints/*
+iframe_figures/*
+.DS_Store
+.directory
+.tox
+.mypy_cache
+examples/data
+test_notebooks
+
+# Project files
+.ropeproject
+.project
+.pydevproject
+.settings
+.idea
+.vscode
+tags
+
+# Unittest and coverage
+htmlcov/*
+.coverage
+.tox
+junit.xml
+coverage.xml
+.pytest_cache/
+
+# Build and docs folder/files
+build/*
+dist/*
+sdist/*
+wheel/*
+.pdm-build
+docs/_build/*
+cover/*
+MANIFEST
+.pdm-python

CHANGELOG.md

@@ -0,0 +1,2 @@
+# 📈 Changelog
+## v0.1.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,126 @@
+# 🫶 Code of Conduct
+
+We follow the code of cunduct defined by the [Contributor Covenant](https://www.contributor-covenant.org/). This document is used across many open source communities, and we think it articulates our values well.
+## Contributor Covenant Code of Conduct
+
+### Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+### Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+### Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+### Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+#### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+#### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+#### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+#### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# 🤝 Contributing to `landmarker`
+
+🎉 **First off all, thank you for considering contributing to `landmarker`!** 🎉
+
+It's people like you that make `landmarker` useful and successful. There are many ways to contribute, here's a few examples:
+* 🐛 [Report bugs](https://github.com/predict-idlab/landmarker/issues/new): Something not working as expected? Please report bugs and we'll try to fix them as soon as possible.
+* 🔨 [Fix bugs](https://github.com/predict-idlab/landmarker/issues): We try to fix bugs as soon as possible. If you want to help, please check the [issues](https://github.com/predict-idlab/landmarker/issues).
+* 🔍 [Improve documentation](https://github.com/predict-idlab/landmarker/pulls): Did you find a typo in the documentation? Or do you think something is missing? Please help us improve the documentation.
+* ✨ [Request/add new features](https://github.com/predict-idlab/landmarker/issues/new): Do you think `landmarker` is missing a feature? Please let us know by creating an issue, however check first if the feature is already requested. Or even better, add the feature yourself and create a pull request.
+* 📝 [Write tutorials](https://github.com/predict-idlab/landmarker/pulls): We are always looking for new tutorials, for example how to use `landmarker` for a specific task. Please help us by writing a tutorial and create a pull request.
+
+For more information on contributing to open source projects, [GitHub's own guide](https://opensource.guide/how-to-contribute) is a great starting point if you are new to version control.
+
+## Setting up your development environment
+
+To get started, fork the `landmarker` repository and clone it to your local machine. Then, install the required dependencies using <a href="https://pdm.fming.dev/" target="_blank">pdm</a> (see <a href="https://pdm-project.org/latest/#installation" target="_blank">installation instructions</a>):
+
+```bash
+pdm install --dev
+```
+
+## Running tests
+`landmarker` uses [pytest](https://docs.pytest.org/en/stable/) for testing. You can run test by running a pdm script, by using the following command:
+
+```bash
+pdm run test
+```
+
+If you want to run pytest with coverage, you can use the following command:
+
+```bash
+pdm run coverage
+```
+
+## Building documentation
+`landmarker` uses [sphinx](https://www.sphinx-doc.org/en/master/) for documentation, and use MyST markdown for documentation pages. You can build the documentation locally by running the following command:
+
+```bash
+pdm run doc
+```
+
+We also support the use of [sphinx-autobuild](https://github.com/executablebooks/sphinx-autobuild), which will automatically rebuild the documentation when a change is detected and live-reload the page in your browser. You can run it using the following command:
+
+```bash
+pdm run docauto
+```
+
+## Ground Rules
+The goal is to maintain a diverse community that's pleasant for everyone.
+**Please be considerate and respectful of others**.
+Everyone must abide by our [Code of Conduct](https://github.com/GenericMappingTools/.github/blob/main/CODE_OF_CONDUCT.md) and we encourage all to read it carefully.

LICENSE

@@ -0,0 +1,30 @@
+IMEC license
+
+Copyright (c) Jef Jonkers
+2023 Ghent University and IMEC vzw with offices at Technologiepark 15,  9052 Ghent, Belgium - Email: [email protected].
+Belgium - Contact info: http://predict.idlab.ugent.be
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software for non-commercial educational and research use, including without
+limitation the rights to use, copy, modify, merge, publish, distribute and/or
+sublicense copies of the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following conditions:
+
+1. The above copyright notice and this permission notice shall be included in
+   all copies of the Software.
+
+2. Permission is restricted to non-commercial educational and research use:
+   the use of the Software is allowed for teaching purposes and academic
+   research. Usage by non-academic parties is allowed in a strict research
+   environment only. The use of the results of the research for commercial
+   purposes or inclusion in commercial activities requires the permission of
+   Ghent University and IMEC vzw.
+
+3. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+   IN THE SOFTWARE.