-
Notifications
You must be signed in to change notification settings - Fork 0
Documentation for Geomfum library
3diglab/geomfum.github.io
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Contributing — GeomFuM 0.1.0 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<!-- So that users can add custom icons -->
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="_static/documentation_options.js?v=01f34227"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'contributing';</script>
<link rel="canonical" href="geomfum.github.io/contributing.html" />
<link rel="icon" href="_static/GeomFuMlogo_only.png"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API Reference" href="api/index.html" />
<link rel="prev" title="How to visualize distance to a point in a mesh?" href="notebooks/how_to/17_vis_dist.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="0.1.0" />
<meta name="docbuild:last-update" content="Jul 24, 2025, 3:18:34 PM"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/GeomFuMlogo.png" class="logo__image only-light" alt="GeomFuM 0.1.0 documentation - Home"/>
<img src="_static/GeomFuMlogo.png" class="logo__image only-dark pst-js-only" alt="GeomFuM 0.1.0 documentation - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="installation.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="usage.html">
Usage
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="concepts/index.html">
Concepts
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorials/index.html">
Tutorials
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Contributing
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="api/index.html">
API Reference
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/DiG-AIR/geomfum" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discord.gg/6sYmEbUp" title="Discord" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-discord fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discord</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="installation.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="usage.html">
Usage
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="concepts/index.html">
Concepts
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="tutorials/index.html">
Tutorials
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
Contributing
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/index.html">
API Reference
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/DiG-AIR/geomfum" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discord.gg/6sYmEbUp" title="Discord" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-discord fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discord</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"></div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">Contributing</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="contributing">
<h1>Contributing<a class="headerlink" href="#contributing" title="Link to this heading">#</a></h1>
<p>We welcome contributions from the community! This guide will help you get started with contributing to GeomFuM.</p>
<section id="getting-started">
<h2>Getting Started<a class="headerlink" href="#getting-started" title="Link to this heading">#</a></h2>
<section id="development-setup">
<h3>Development Setup<a class="headerlink" href="#development-setup" title="Link to this heading">#</a></h3>
<p>The instructions in this section detail the step-by-step
process on setting up your development environment before
contribution.</p>
<p>We recommend using <cite>Git</cite> for source control to allow collaboration. Typical interaction with the project involves using <cite>git</cite> to pull/push code and
submitting bugs/feature requests to the <a class="reference external" href="https://github.com/DiG-AIR/geomfum">GeomFuM repository</a>.</p>
<p>Be sure to follow the Git installation and configuration instructions for your
respective operating system from the
<a class="reference external" href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git">official Git documentation</a>,
before you follow along the next section of this documentation.</p>
<ol class="arabic">
<li><p><strong>Fork the repository</strong>:
Visit <cite>https://github.com/DiG-AIR/geomfum</cite> and click “Fork”</p></li>
<li><p><strong>Clone your fork</strong>:
.. code-block:: bash</p>
<blockquote>
<div><p>git clone <a class="github reference external" href="https://github.com">github</a>/<your-username>/geomfum.git
cd geomfum</p>
</div></blockquote>
</li>
<li><p><strong>Install in development mode</strong>:
.. code-block:: bash</p>
<blockquote>
<div><p>pip install -e .[test,,plotting-all]</p>
</div></blockquote>
</li>
</ol>
</section>
<section id="development-environment">
<h3>Development Environment<a class="headerlink" href="#development-environment" title="Link to this heading">#</a></h3>
<p>We recommend using a virtual environment to manage dependencies:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Create virtual environment</span>
python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>geomfum_env
<span class="nb">source</span><span class="w"> </span>geomfum_env/bin/activate<span class="w"> </span><span class="c1"># On Windows: geomfum_env\Scripts\activate</span>
<span class="c1"># Install development dependencies</span>
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="o">[</span>test,test-scripts,plotting-all<span class="o">]</span>
</pre></div>
</div>
</section>
</section>
<section id="code-style">
<h2>Code Style<a class="headerlink" href="#code-style" title="Link to this heading">#</a></h2>
<p>We follow PEP 8 and use several tools to maintain code quality:</p>
<section id="formatting">
<h3>Formatting<a class="headerlink" href="#formatting" title="Link to this heading">#</a></h3>
<p>We use <cite>ruff</cite> for code formatting and linting. We recommend downloading the extension for your preferred IDE editor.</p>
</section>
<section id="documentation">
<h3>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">#</a></h3>
<p>The documentation is written in <cite>rst</cite> format and is located in the <cite>docs/</cite> directory.
The documentation is built using <cite>sphinx</cite> and is located in <cite>https://DiG-AIR.github.io/geomfum.github.io/</cite> directory.
The documentation is viewable in a web browser.</p>
</section>
<section id="writing-documentation">
<h3>Writing Documentation<a class="headerlink" href="#writing-documentation" title="Link to this heading">#</a></h3>
<ol class="arabic simple">
<li><p><strong>API Documentation</strong>: Add docstrings to all public functions</p></li>
<li><p><strong>Tutorials</strong>: Create Jupyter notebooks in <cite>notebooks/</cite></p></li>
<li><p><strong>Concept Documentation</strong>: Add theoretical explanations in <cite>docs/concepts/</cite></p></li>
</ol>
<p>Example docstring:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">zoomout_refinement</span><span class="p">(</span>
<span class="n">functional_map</span><span class="p">:</span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span>
<span class="n">mesh1</span><span class="p">:</span> <span class="n">Mesh</span><span class="p">,</span>
<span class="n">mesh2</span><span class="p">:</span> <span class="n">Mesh</span><span class="p">,</span>
<span class="n">iterations</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">5</span>
<span class="p">)</span> <span class="o">-></span> <span class="n">np</span><span class="o">.</span><span class="n">ndarray</span><span class="p">:</span>
<span class="w"> </span><span class="sd">"""Apply ZoomOut refinement to functional map.</span>
<span class="sd"> ZoomOut is a spectral upsampling technique that improves</span>
<span class="sd"> correspondence quality by iteratively refining the functional map.</span>
<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> functional_map : np.ndarray</span>
<span class="sd"> Input functional map matrix</span>
<span class="sd"> mesh1 : Mesh</span>
<span class="sd"> First mesh</span>
<span class="sd"> mesh2 : Mesh</span>
<span class="sd"> Second mesh</span>
<span class="sd"> iterations : int, optional</span>
<span class="sd"> Number of refinement iterations, by default 5</span>
<span class="sd"> Returns</span>
<span class="sd"> -------</span>
<span class="sd"> np.ndarray</span>
<span class="sd"> Refined functional map</span>
<span class="sd"> References</span>
<span class="sd"> ----------</span>
<span class="sd"> .. [1] Melzi, S., et al. "ZoomOut: Spectral Upsampling for Efficient</span>
<span class="sd"> Shape Correspondence." ACM TOG 38.6 (2019): 155.</span>
<span class="sd"> """</span>
<span class="k">pass</span>
</pre></div>
</div>
</section>
</section>
<section id="pull-request-process">
<h2>Pull Request Process<a class="headerlink" href="#pull-request-process" title="Link to this heading">#</a></h2>
<ol class="arabic">
<li><p><strong>Create a feature branch</strong>:
.. code-block:: bash</p>
<blockquote>
<div><p>git checkout -b feature/your-feature-name</p>
</div></blockquote>
</li>
<li><p><strong>Make your changes</strong>:
- Write code following our style guidelines
- Add tests for new functionality
- Update documentation</p></li>
<li><p><strong>Run tests and checks</strong>:
.. code-block:: bash</p>
<blockquote>
<div><p># Run tests
pytest</p>
</div></blockquote>
</li>
<li><p><strong>Commit your changes</strong>:
.. code-block:: bash</p>
<blockquote>
<div><p>git add .
git commit -m “Add feature: brief description”</p>
<p># Use conventional commit format:
# feat: add new functional map refinement
# fix: resolve memory leak in laplacian computation
# docs: update installation instructions</p>
</div></blockquote>
</li>
<li><p><strong>Push and create PR</strong>:
.. code-block:: bash</p>
<blockquote>
<div><p>git push origin feature/your-feature-name</p>
</div></blockquote>
</li>
<li><p><strong>Create Pull Request</strong>:
- Use the PR template
- Describe your changes clearly
- Link related issues
- Request reviews from maintainers</p></li>
<li><p><strong>Wait for review</strong>:
- Address feedback from maintainers
- Make changes as requested
- Re-request review when ready
- Ensure all checks pass before merging
- Merge when approved</p></li>
</ol>
</section>
<section id="code-review">
<h2>Code Review<a class="headerlink" href="#code-review" title="Link to this heading">#</a></h2>
<section id="review-process">
<h3>Review Process<a class="headerlink" href="#review-process" title="Link to this heading">#</a></h3>
<ol class="arabic simple">
<li><p><strong>Automated checks</strong> must pass:
- Tests
- Code style
- Documentation build
- Type checking</p></li>
<li><p><strong>Manual review</strong> by maintainers:
- Code quality
- Algorithm correctness
- Performance considerations
- Documentation quality</p></li>
<li><p><strong>Address feedback</strong>:
- Respond to review comments
- Make requested changes
- Re-request review when ready</p></li>
</ol>
</section>
<section id="review-guidelines">
<h3>Review Guidelines<a class="headerlink" href="#review-guidelines" title="Link to this heading">#</a></h3>
<p>When reviewing code:</p>
<ol class="arabic simple">
<li><p><strong>Check correctness</strong>: Is the algorithm implemented correctly?</p></li>
<li><p><strong>Check performance</strong>: Are there performance issues?</p></li>
<li><p><strong>Check style</strong>: Does the code follow our conventions?</p></li>
<li><p><strong>Check documentation</strong>: Is the documentation clear and complete?</p></li>
<li><p><strong>Check tests</strong>: Are there adequate tests?</p></li>
</ol>
</section>
</section>
<section id="areas-for-contribution">
<h2>Areas for Contribution<a class="headerlink" href="#areas-for-contribution" title="Link to this heading">#</a></h2>
<p>We welcome contributions in these areas:</p>
<section id="algorithms">
<h3>Algorithms<a class="headerlink" href="#algorithms" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>New functional map algorithms</p></li>
<li><p>Improved refinement techniques</p></li>
<li><p>Novel shape descriptors</p></li>
<li><p>Deep learning approaches</p></li>
</ul>
</section>
<section id="performance">
<h3>Performance<a class="headerlink" href="#performance" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>GPU acceleration</p></li>
<li><p>Parallel processing</p></li>
<li><p>Memory optimization</p></li>
<li><p>Sparse matrix operations</p></li>
</ul>
</section>
<section id="id1">
<h3>Documentation<a class="headerlink" href="#id1" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Tutorials and examples</p></li>
<li><p>API documentation</p></li>
<li><p>Theoretical explanations</p></li>
<li><p>Performance benchmarks</p></li>
</ul>
</section>
<section id="testing">
<h3>Testing<a class="headerlink" href="#testing" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Unit tests</p></li>
<li><p>Integration tests</p></li>
<li><p>Performance tests</p></li>
<li><p>Documentation tests</p></li>
</ul>
</section>
<section id="tools-and-utilities">
<h3>Tools and Utilities<a class="headerlink" href="#tools-and-utilities" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>Visualization tools</p></li>
<li><p>Data processing utilities</p></li>
<li><p>Evaluation metrics</p></li>
<li><p>Benchmarking tools</p></li>
</ul>
</section>
</section>
<section id="getting-help">
<h2>Getting Help<a class="headerlink" href="#getting-help" title="Link to this heading">#</a></h2>
<p>If you need help:</p>
<ol class="arabic simple">
<li><p><strong>Check existing issues</strong>: Search for similar problems</p></li>
<li><p><strong>Join Discord</strong>: <cite>https://discord.gg/6sYmEbUp</cite></p></li>
<li><p><strong>Create an issue</strong>: For bugs or feature requests</p></li>
<li><p><strong>Ask questions</strong>: In GitHub Discussions</p></li>
</ol>
</section>
<section id="community-guidelines">
<h2>Community Guidelines<a class="headerlink" href="#community-guidelines" title="Link to this heading">#</a></h2>
<p>We are committed to providing a welcoming and inclusive environment:</p>
<ol class="arabic simple">
<li><p><strong>Be respectful</strong>: Treat everyone with respect</p></li>
<li><p><strong>Be helpful</strong>: Help others learn and contribute</p></li>
<li><p><strong>Be patient</strong>: Everyone learns at their own pace</p></li>
<li><p><strong>Be constructive</strong>: Provide constructive feedback</p></li>
</ol>
<section id="code-of-conduct">
<h3>Code of Conduct<a class="headerlink" href="#code-of-conduct" title="Link to this heading">#</a></h3>
<p>We follow the Contributor Covenant Code of Conduct. Please read it at:
<cite>https://www.contributor-covenant.org/version/2/0/code_of_conduct.html</cite></p>
</section>
</section>
<section id="recognition">
<h2>Recognition<a class="headerlink" href="#recognition" title="Link to this heading">#</a></h2>
<p>Contributors are recognized in:</p>
<ol class="arabic simple">
<li><p><strong>GitHub contributors list</strong></p></li>
<li><p><strong>Documentation acknowledgments</strong></p></li>
<li><p><strong>Release notes</strong></p></li>
<li><p><strong>Academic citations</strong> (for significant contributions)</p></li>
</ol>
<p>Thank you for contributing to GeomFuM! 🎉</p>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="notebooks/how_to/17_vis_dist.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">How to visualize distance to a point in a mesh?</p>
</div>
</a>
<a class="right-next"
href="api/index.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">API Reference</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#getting-started">Getting Started</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#development-setup">Development Setup</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#development-environment">Development Environment</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-style">Code Style</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#formatting">Formatting</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#documentation">Documentation</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#writing-documentation">Writing Documentation</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pull-request-process">Pull Request Process</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#code-review">Code Review</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#review-process">Review Process</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#review-guidelines">Review Guidelines</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#areas-for-contribution">Areas for Contribution</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#algorithms">Algorithms</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#performance">Performance</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#id1">Documentation</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#testing">Testing</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#tools-and-utilities">Tools and Utilities</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#getting-help">Getting Help</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#community-guidelines">Community Guidelines</a><ul class="visible nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#code-of-conduct">Code of Conduct</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#recognition">Recognition</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/contributing.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2025, GeomFuM contributors.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>About
Documentation for Geomfum library
Contributing
Stars
Watchers
Forks
Releases
No releases published
Packages 0
No packages published