Initial commit

Author: lineick

.dockerignore

@@ -0,0 +1,134 @@
+**/TODO
+**/mamba*
+pl-training.yml
+.vscode
+
+# Project folders/files
+# use-cases
+workflows
+CHANGELOG
+
+# Docs
+docs
+
+# interLink pods
+**/interLink
+**/interlink
+
+# Data
+**/MNIST
+**/*-predictions/
+**/*-data/
+**/*.tar.gz
+**/exp_data
+
+# Logs
+**/logs
+**/lightning_logs
+**/mlruns
+**/.logs
+**/mllogs
+**/nohup*
+**/*.out
+**/*.err
+**/checkpoints/
+**/*_logs
+**/tmp*
+**/.tmp*
+
+# Markdown
+**/*.md
+
+# Custom envs
+**/.venv*
+
+# Git
+.git
+.gitignore
+.github
+
+# CI
+.codeclimate.yml
+.travis.yml
+.taskcluster.yml
+
+# Docker
+docker-compose.yml
+.docker
+.dockerignore
+Dockerfile
+
+# Byte-compiled / optimized / DLL files
+**/__pycache__/
+**/*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+**/eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+**/*.egg-info/
+**/.installed.cfg
+**/*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Virtual environment
+.env/
+.venv/
+venv/
+
+# PyCharm
+.idea
+
+# Python mode for VIM
+.ropeproject
+*/.ropeproject
+*/*/.ropeproject
+*/*/*/.ropeproject
+
+# Vim swap files
+*.swp
+*/*.swp
+*/*/*.swp
+*/*/*/*.swp

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,94 @@
+# Code of Conduct
+
+This code of conduct applies to the maintainers and contributors alike.
+
+## Dealing with issues and support requests
+
+_We wish to add a specific section on dealing with issues opened against the
+repository here._
+
+This repository exists in the context of the interTwin project. While that scope
+does not restrict the usage, it does inform the priority we assign to issues and
+the order we deal with them.
+
+We welcome issues reported by the public, and more specifically the community of
+people using this repository.
+
+While we undertake to do everything in our power to respond to issues in a
+timely manner, and to prioritise issues based on reasonable requests from
+submitters, the maintainers expect that the prioritisation of issues as decided
+by them is respected.
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behaviour by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers 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, or to ban temporarily or permanently any
+contributor for other behaviours that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project email
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the interTwin project team at
+[info@interTwin.eu](mailto:info@interTwin.eu). The team will
+review and investigate all complaints, and will respond in a way that it deems
+appropriate to the circumstances. The team is obligated to maintain
+confidentiality with regard to the reporter of an incident. Further details of
+specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,52 @@
+<!--
+Thank you for opening an issue in our repository.
+Please use the template below to construct the issue.
+
+Dealing with issues:
+- Issues opened here will be evaluated by the maintainers, and given priority
+  based on that evaluation.
+- Support is provided on a best-effort basis
+- See the CODE_OF_CONDUCT.md for a deeper description of how we deal with support
+  and issues.
+-->
+
+# Short Description of the issue
+
+<!--
+Please provide a plain-language description of what you would like to report.
+By using simple, concise language, you can help the maintainers understand the
+issue and context, and thereby help them prioritise it.
+-->
+
+## Environment
+
+<!--
+Provide details of the environment you used when this error occurred
+-->
+
+- Operating System:
+- Other related components versions:
+
+## Steps to reproduce
+
+<!--
+If this is a runtime or other error, please describe what you did to generate the
+error
+-->
+
+## Logs, stacktrace, or other symptoms
+
+<!--
+If you have logs or other supporting information like the stack trace from python,
+etc, paste it here.
+Use markdown formatting to put output in code blocks
+-->
+
+```shell
+output
+```
+
+<!-- the section below is optional - remove it if you don't know what to propose,
+but merely want to report an issue.  -->
+
+# Summary of proposed changes

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+<!--
+A good PR should describe what benefit this brings to the repository.
+Ideally, there is an existing issue which the PR address.
+
+Please check the Contributing guide CONTRIBUTING.md for style requirements and
+advice.
+-->
+
+# Summary
+
+<!-- Describe in plain English what this PR does -->
+
+---
+
+<!-- Add, if any, the related issue here, e.g. #6 -->
+
+**Related issue :**

.github/dependabot.yml

@@ -0,0 +1,8 @@
+---
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/linters/.flake8

@@ -0,0 +1,4 @@
+[flake8]
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8
+extend-ignore = E203,W503
+max-line-length = 88

.github/linters/.markdownlint.json

@@ -0,0 +1,12 @@
+{
+  "MD013": {
+    "line_length": 120,
+    "code_blocks": false,
+    "tables": false
+  },
+  "MD014": false,
+  "MD024": false,
+  "MD026": {
+    "punctuation": ".,:;!"
+  }
+}

.github/linters/.ruff.toml

@@ -0,0 +1,11 @@
+line-length = 95
+
+[lint]
+select = ["E", "F", "I"]
+ignore = ["E203"]
+
+[format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"

.github/linters/mlc_config.json

@@ -0,0 +1,24 @@
+{
+  "httpHeaders": [
+    {
+      "urls": ["https://docs.github.com/"],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ],
+  "ignorePatterns": [
+    {
+      "pattern": "^http://localhost"
+    },
+    {
+      "pattern": "^https://example.com"
+    },
+    {
+      "pattern": "https://github.com/interTwin-eu/REPOSITORY/issues/new"
+    },
+    {
+      "pattern": "https://github.com/interTwin-eu/REPOSITORY/graphs/contributors"
+    }
+  ]
+}

.github/workflows/check-links.yml

@@ -0,0 +1,30 @@
+---
+name: Check links
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  markdown-link-check:
+    name: Check links using markdown-link-check
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks out a copy of your repository on the ubuntu-latest machine
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Make sure the actual branch is checked out when running on PR
+          # ref: ${{ github.event.pull_request.head.sha }}
+          # Full git history needed to get proper list of changed files
+          fetch-depth: 0
+
+      - name: Check links on new changes
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          config-file: ".github/linters/mlc_config.json"
+          check-modified-files-only: "yes"
+          use-quiet-mode: "yes"
+          use-verbose-mode: "yes"
+          base-branch: "main"