delta-microscopy 3.0.0a0__tar.gz

delta_microscopy-3.0.0a0/.git-blame-ignore-revs

@@ -0,0 +1,10 @@
+# For this file to take effect make sure you use git ^2.23 and
+# add blame.ignoreRevsFile to your git configuration:
+# ```
+# git config --global blame.ignoreRevsFile .git-blame-ignore-revs
+# ```
+
+# Renormalize line endings
+65987a58536562f4e6283d2992ea452ae1764570
+# Run black on the codebase
+0dad305daa83193a1f4cc8d985b4c8bc46a3865f

delta_microscopy-3.0.0a0/.gitattributes

@@ -0,0 +1,2 @@
+# SCM syntax highlighting
+pixi.lock linguist-language=YAML linguist-generated=true

delta_microscopy-3.0.0a0/.gitignore

@@ -0,0 +1,160 @@
+# Ignore assets folder:
+/delta/assets/
+
+# Ignore test results folder:
+/tests/data/**/results
+/tests/data/**/delta_results
+/tests/data/**/roi_masks
+/tests/data/**/segmentation
+/tests/data/**/tracking
+/tests/data/**/test_delta_results
+
+# Ignore auto-generated docs pages:
+/docs/source/generated/
+/docs/_generated/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# JetBrains IDEs project settings
+.idea
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# pixi environments
+.pixi
+*.egg-info

delta_microscopy-3.0.0a0/.gitlab-ci.yml

@@ -0,0 +1,143 @@
+stages:
+  - test
+  - publish
+
+pre-commit:
+  stage: test
+
+  image: python:latest
+
+  rules:
+    - if: "$CI_MERGE_REQUEST_LABELS =~ /tests::block/"
+      when: never
+    - if: "$CI_MERGE_REQUEST_LABELS =~ /tests::force/"
+    - if: "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH"
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
+
+  before_script:
+    - python --version
+    - pip install pre-commit
+
+  script:
+    - pre-commit run --all-files
+
+test-notraining:
+  stage: test
+
+  image: python:3.12
+
+  rules:
+    - if: "$CI_MERGE_REQUEST_LABELS =~ /tests::block/"
+      when: never
+    - if: "$CI_MERGE_REQUEST_LABELS =~ /tests::force/"
+    - if: "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH"
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
+
+  cache:
+    # only caching delta data, everything else is reinstalled via pip
+    - key: delta-cache
+      paths:
+        - .cache/delta
+
+  variables:
+    DELTA_ASSETS_CACHE: ".cache/delta"
+    PIP_CACHE_DIR: ".cache/pip"
+
+  before_script:
+    - date
+    - apt update
+    - apt install -y ffmpeg
+    - pip install .[jax-cpu]
+    - export KERAS_BACKEND=jax
+    - curl -Os https://uploader.codecov.io/latest/linux/codecov
+    - chmod +x codecov
+
+  script:
+    - date
+    # * Removing test_train because they are too long for gitlab CI
+    - pytest --verbose --cov=delta -k "not test_train"
+    - ./codecov -t $CODECOV_TOKEN
+
+  after_script:
+    - rm -rf .cache/delta/0.0.1/unzipped
+
+test-training:
+  stage: test
+
+  tags:
+    - saas-linux-medium-amd64
+
+  image: python:3.12
+
+  rules:
+    - if: "$CI_MERGE_REQUEST_LABELS =~ /tests::block/"
+      when: never
+    - if: "$CI_MERGE_REQUEST_LABELS =~ /tests::force/"
+    - if: "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH"
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
+
+  cache:
+    # only caching delta data, everything else is reinstalled via pip
+    - key: delta-cache
+      paths:
+        - .cache/delta
+
+  variables:
+    DELTA_ASSETS_CACHE: ".cache/delta"
+    PIP_CACHE_DIR: ".cache/pip"
+
+  before_script:
+    - date
+    - apt update
+    - apt install -y ffmpeg
+    - pip install .[jax-cpu]
+    - export KERAS_BACKEND=jax
+    - curl -Os https://uploader.codecov.io/latest/linux/codecov
+    - chmod +x codecov
+
+  script:
+    - date
+    - python -c "import jax; print(jax.devices())"
+    - pytest --verbose --cov=delta -k "test_train"
+    - ./codecov -t $CODECOV_TOKEN
+
+  after_script:
+    - rm -rf .cache/delta/0.0.1/unzipped
+
+test-build:
+  stage: test
+
+  image: python:latest
+
+  script:
+    - pip install hatch
+    - hatch build
+
+PyPI-upload:
+  stage: publish
+
+  image: python:latest
+
+  rules:
+    - if: "$CI_COMMIT_TAG"
+
+  script:
+    - pip install hatch
+    - hatch build
+    - hatch publish
+
+GitLab-release:
+  stage: publish
+
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+
+  rules:
+    - if: "$CI_COMMIT_TAG"
+
+  script:
+    - echo "Running the GitLab release job."
+
+  release:
+    tag_name: $CI_COMMIT_TAG
+    name: "Release $CI_COMMIT_TAG"
+    description: "Release created using the release-cli."

delta_microscopy-3.0.0a0/.pre-commit-config.yaml

@@ -0,0 +1,61 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-ast
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: check-yaml
+      - id: check-toml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+      - id: name-tests-test
+        args: [--pytest-test-first]
+        exclude: "tests/utils.py"
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-check-blanket-noqa
+      - id: python-check-blanket-type-ignore
+      - id: python-check-mock-methods
+      - id: python-no-eval
+      - id: python-no-log-warn
+      - id: python-use-type-annotations
+      - id: rst-backticks
+      - id: rst-directive-colons
+      - id: rst-inline-touching-normal
+      - id: text-unicode-replacement-char
+  - repo: https://github.com/rbubley/mirrors-prettier
+    rev: v3.6.2
+    hooks:
+      - id: prettier
+        types_or: [markdown, rst, toml]
+  - repo: https://github.com/adamchainz/blacken-docs
+    rev: 1.19.1
+    hooks:
+      - id: blacken-docs
+        additional_dependencies:
+          - black==24.8.0
+  - repo: https://github.com/sphinx-contrib/sphinx-lint
+    rev: v1.0.0
+    hooks:
+      - id: sphinx-lint
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.36.1
+    hooks:
+      - id: typos
+        args:
+          - --config=.typos.toml
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.11
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: [--fix, --show-fixes]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.17.1
+    hooks:
+      - id: mypy

delta_microscopy-3.0.0a0/.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3.12"

delta_microscopy-3.0.0a0/.typos.toml

@@ -0,0 +1,15 @@
+# Configuration file for the `typos` spell-checker
+# https://github.com/crate-ci/typos
+
+[default.extend-words]
+nd = "nd"   # for .nd2 files
+nly = "nly"  # two occurences in imgops.py
+ome = "ome"  # for the OME-TIFF format
+Ba = "Ba"  # a random string in an asset url
+GTI = "GTI"  # a random string in an asset url
+Comput = "Comput"  # abbrevation of PLoS Comput Biol
+setp = "setp"  # matplotlib
+
+[type.svg]
+extend-glob = ["*.svg"]
+check-file = false

delta_microscopy-3.0.0a0/CHANGELOG.md

@@ -0,0 +1,180 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+### Added
+
+- DeLTA now computes the growth rate of the cells.
+- It is now possible to specify the number of convolution kernels at each
+  layer when creating a U-Net.
+- Added support for TensorBoard.
+- The function `delta.data.make_weights` can create all of the weight maps
+  for a training dataset.
+- The function `delta.utilities.read_image` reads and normalises png, tif and
+  more.
+- The function `load_training_dataset_seg` loads training datasets and allows
+  to specify validation and test splits.
+- DeLTA's configuration is now its own `Config` object instead of many
+  variables dispersed in `delta.config`. Configuration files are read with
+  `Config.read`, and the resulting `config` should be passed to `Pipeline`
+  at its creation.
+- Positions can now be loaded with the static method `Position.load`.
+- Methods were added to the class `CroppingBox`: notably `full` (to create a
+  box from a whole reference image) and `crop` (to crop an image according to
+  the box).
+- Added a commandline interface to DeLTA accessible with `delta`.
+- Added a flag to label the output movie with cellids (`--label-movie`).
+- Added the function `utils.training_callbacks` to simplify training.
+- Added a flag to modify the config on the fly (`-C`).
+
+### Changed
+
+- All unet models return now logits, instead of probabilities, to improve
+  numerical accuracy.
+- The function `seg_weights` is faster by a factor 20.
+- The function `seg_weights_2D` is faster by a factor 12.
+- Upgraded tensorflow dependency to version 2.7.
+- Upgraded OpenCV dependency to version 4.6.
+- Dropped support for Python 3.7.
+- Switched from `setup.py` to `pyproject.toml`.
+- DeLTA assets (models, training sets, evaluation movies) are downloaded
+  automatically and cached, thanks to the python package `pooch`.
+- The function `xpreader.getframes` now only takes one position at a time.
+- The functions `extract_poles` and `getpoles` now return a dictionary instead
+  of a list.
+- The function `getrandomcolors` now returns a dictionary instead of a list.
+- The attribute `lineage.cells` is now a dictionary instead of a list.
+- `CroppingBox` is now a `dataclass`, instead of a dictionary.
+- The function `affine_transform` now takes an `angle` argument to perform a
+  rotation.
+- The `label_stack` is now created by `process_tracking_outputs`.
+- The function `roi_features` now returns a dictionary instead of a list.
+- The argument `features` was removed from `extract_features` and
+  `roi_features`: now, every possible feature is always returned.
+- The `threshold` argument of `binarizerange` is now compulsory, but one can
+  still pass `None` to binarize in the middle of the dynamic range.
+- The function `getpoles`'s argument `labels` is now compulsory.
+- No need to specify `features` to `Pipeline.process` anymore: they are
+  always all returned.
+- The functions `track_poles` and `division_poles` (from `utilities`), and
+  `createcell`, `updatecell` and `update` (from `Lineage`) changed their
+  parameters to now take a `CellFeatures` object instead of a couple of poles.
+- The functions `Pipeline.process`, `Position.segment`, `Position.track`,
+  `Position.features`, `Position.save`, `Position.results_movie`, and
+  `xpreader.getframes` now get an integer argument `nbframes` instead of a list
+  `frames`.
+- Renamed `xpreader` into `XPReader`.
+- There are now no more `prototype`, `fileorder`, or `filenamesindexing`
+  parameters to `XPReader`, just one `path` which can be templated with `{p}`,
+  `{c}` and `{t}`.
+- `python-bioformats` has been replaced by `aicsimageio` and thus removes the
+  Java dependency for most image file formats.
+- Replaced the `utils.Lineage` with the new `lineage.Lineage`.
+- Cells are now counted up from 1 instead of 0.
+- Improved and robustify growthrate computation.
+- Renamed `utils.tracking_boxes` to `utils.tracking_box` and make it return only
+  one `CroppingBox` (`CroppingBox` having removed the need for a `fillbox`).
+- Split `correct_drift` into two separate functions: `compute_drift` and
+  `correct_drift`.
+- Made `affine_transform` take a shift in pixels and not in ratio.
+- The function `utils.poles` now identifies cell poles based on contour
+  curvature, not morphological skeletons.
+- The function `utils.cell_width_length` now uses the cell's centerline between
+  the two poles to measure cell length and width.
+- The function `utils.find_poles` now takes a single contour, not an image.
+
+### Fixed
+
+- Fixed bug in the computation of cell perimeters.
+- Fixed training reproducibility bugs by using seeded random generators.
+- Fixed edge case bugs in 2D image stitching.
+- Fixed edge case bug on pole detection of singular cells.
+- Fixed incorrect numbering of position, channel and frame from input to
+  output.
+- Fixed rotate_image behavior to rotate images about their exact center.
+- Fixed `correct_drift` drift computation.
+
+### Removed
+
+- The function `trainGenerator_seg` was removed.
+- The function `download_assets` was removed, because assets are now downloaded
+  on the fly.
+- The `load_position` was removed in favor of `Position.load`.
+- The function `load_config` was removed, replaced by `config.Config.read` and
+  `config.Config.load`.
+- The function `utils.cropbox` was removed, replaced by `CroppingBox.crop`.
+- The function `singlecell_features` was removed because used only once.
+- The method `ROI.extract_features` was removed: features are now extracted
+  during tracking.
+- The old commandline behavior was removed, in favor of `python -m delta`.
+- The `use_bioformats` parameter to `XPReader` was removed, now it should guess
+  automatically whether bioformats should be used or not.
+- The function `utils.shift_values` was removed.
+
+## \[2.0.5\] - 2022-03-11
+
+### Changed
+
+- Adjusted the executable bit of source files
+- Removed tifffile from dependency list
+- Fixed GPU memory crash when training by using cv2.imread in data module
+- Rewrote the `deskew` (detection of rotation) function to be deterministic
+  and more accurate
+- Corrected Pipeline reloading bug
+
+## \[2.0.4\] - 2022-02-25
+
+### Changed
+
+- Updated assets module to new google drive download API
+
+## \[2.0.3\] - 2022-02-02
+
+### Changed
+
+- U-Net "number of levels" now parametrized
+- Corrected bugs with poles tracking
+- Added poles information to legacy MAT savefiles
+
+## \[2.0.2\] - 2022-01-17
+
+### Changed
+
+- Rewrote utilities.getrandomcolors to be dependent on cv2 instead of matplotlib
+
+## \[2.0.1\] - 2022-01-12
+
+### Added
+
+- Added matploblib to requirements.txt
+
+## \[2.0.0\] - 2022-01-12
+
+### Added
+
+- Full-python pipeline for both 2D and mother machine time-lapse analysis
+- [python-bioformats](https://github.com/CellProfiler/python-bioformats) integration
+- [Online documentation](https://delta.readthedocs.io/en/latest/)
+- [PyPI package](https://pypi.org/project/delta2/)
+- [conda-forge package](https://anaconda.org/conda-forge/delta2)
+- [Google Colab notebook](https://colab.research.google.com/drive/1UL9oXmcJFRBAm0BMQy_DMKg4VHYGgtxZ)
+- Example scripts for data analysis and training & evaluation
+- pytest tests suite & systematic testing on dev branch
+- Systematic type hinting & standardization of data types
+- CI/CD pipeline for PyPI deployment
+- Changelog
+
+### Changed
+
+- JSON configuration files
+- Automated assets download of [training sets, latest models etc...](https://drive.google.com/drive/u/0/folders/1nTRVo0rPP9CR9F6WUunVXSXrLNMT_zCP)
+- [Black](https://black.readthedocs.io/en/stable/) formatting
+
+### Removed
+
+- Matlab-related code

delta_microscopy-3.0.0a0/CODE_OF_CONDUCT.md

@@ -0,0 +1,85 @@
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, **contact one of the members of the board.**
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+## Addressing and Repairing Harm
+
+---
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1. Warning
+   1. Event: A violation involving a single incident or series of incidents.
+   2. Consequence: A private, written warning from the Community Moderators.
+   3. Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2. Temporarily Limited Activities
+   1. Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2. Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3. Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3. Temporary Suspension
+   1. Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2. Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3. Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4. Permanent Ban
+   1. Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2. Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3. Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other 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.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).