Add docs

.github/workflows/docs.yml

@@ -0,0 +1,18 @@
+name: docs
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v2
+      - run: pip install --upgrade pip && pip install install mkdocs-material && pip install mkdocs-minify-plugin
+      - run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
+      - name: Publish docs
+        run: mkdocs gh-deploy --force

.gitignore

@@ -160,3 +160,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+site

docs/blog/index.md

@@ -0,0 +1,2 @@
+# Blog
+

docs/index.md

@@ -0,0 +1,33 @@
+![Vinícius Mesquita / DALEE - theropod, jurassic landscape, digital art, hight quality](assets/Logo.jpg)
+
+#  **Time Series Extraction for Polygonal Data**
+
+### Name
+- T(h)eroPoDa + - Time Series Extraction for Polygonal Data and Trend Analysis ⬛
+
+### Description
+- Toolkit created to extract Time Series information from Sentinel 2 🛰 data stored in Earth Engine, gap filling and trend analysis [![image](https://user-images.githubusercontent.com/13785909/209228496-9fe31adc-a7cb-47c3-b476-64d82541f139.png)](https://earthengine.google.com/)
+
+### Author
+- Vinícius Vieira Mesquita - [email protected] (Main Theropoda)
+### Co-author
+- Leandro Leal Parente - [email protected] (Gap Filling and Trend Analysis implementation)
+
+### Version
+- 1.1.0
+
+### How to use
+
+- At this version of TheroPoDa (1.1.0), you could extract a series of NDVI data from Sentinel 2 for a Feature Collection of polygons simplily by adjusting some variables at the end of code:
+
+| variable      | usage                                               | example  |
+|:-------------:|:--------------------------------------------------: |:---------|
+| asset         | Choosed Earth Engine Vector Asset                   | users/vieiramesquita/LAPIG_FieldSamples/lapig_goias_fieldwork_2022_50m |
+| id_field      | Vector column used as ID (use unique identifiers!) | ID_POINTS |
+| output_name   | Output filename                                     | LAPIG_Pasture_S2_NDVI_Monitoring_FieldWork.csv |
+
+### Roadmap
+
+- Implement arguments to choose other zonal reducers (i.e. percentile, variance, etc.)
+- Implement arguments to choose other satellite data series (i.e. Landsat series, MODIS products)
+- Implement a visualization of the processed data (or samples of it)

docs/material/__init__.py

@@ -0,0 +1,21 @@
+# Copyright (c) 2016-2024 Martin Donath <[email protected]>
+
+# 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 without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# 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 NON-INFRINGEMENT. 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.
+
+__version__ = "9.5.27"

docs/material/extensions/__init__.py

@@ -0,0 +1,19 @@
+# Copyright (c) 2016-2024 Martin Donath <[email protected]>
+
+# 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 without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# 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 NON-INFRINGEMENT. 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.

docs/material/extensions/emoji.py

@@ -0,0 +1,98 @@
+# Copyright (c) 2016-2024 Martin Donath <[email protected]>
+
+# 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 without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+
+# 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 NON-INFRINGEMENT. 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.
+
+from __future__ import annotations
+
+import codecs
+import functools
+import material
+import os
+
+from glob import iglob
+from inspect import getfile
+from markdown import Markdown
+from pymdownx import emoji, twemoji_db
+from xml.etree.ElementTree import Element
+
+# -----------------------------------------------------------------------------
+# Functions
+# -----------------------------------------------------------------------------
+
+# Create twemoji index
+def twemoji(options: object, md: Markdown):
+    paths = options.get("custom_icons", [])[:]
+    return _load_twemoji_index(tuple(paths))
+
+# Create emoji or icon
+def to_svg(
+    index: str, shortname: str, alias: str, uc: str | None, alt: str,
+    title: str, category: str, options: object, md: Markdown
+):
+    if not uc:
+        icons = md.inlinePatterns["emoji"].emoji_index["emoji"]
+
+        # Create and return element to host icon
+        el = Element("span", { "class": options.get("classes", index) })
+        el.text = md.htmlStash.store(_load(icons[shortname]["path"]))
+        return el
+
+    # Delegate to `pymdownx.emoji` extension
+    return emoji.to_svg(
+        index, shortname, alias, uc, alt, title, category, options, md
+    )
+
+# -----------------------------------------------------------------------------
+# Helper functions
+# -----------------------------------------------------------------------------
+
+# Load icon
+@functools.lru_cache(maxsize = None)
+def _load(file: str):
+    with codecs.open(file, encoding = "utf-8") as f:
+        return f.read()
+
+# Load twemoji index and add icons
+@functools.lru_cache(maxsize = None)
+def _load_twemoji_index(paths):
+    index = {
+        "name": "twemoji",
+        "emoji": twemoji_db.emoji,
+        "aliases": twemoji_db.aliases
+    }
+
+    # Compute path to theme root and traverse all icon directories
+    root = os.path.dirname(getfile(material))
+    root = os.path.join(root, "templates", ".icons")
+    for path in [*paths, root]:
+        base = os.path.normpath(path)
+
+        # Index icons provided by the theme and via custom icons
+        glob = os.path.join(base, "**", "*.svg")
+        glob = iglob(os.path.normpath(glob), recursive = True)
+        for file in glob:
+            icon = file[len(base) + 1:-4].replace(os.path.sep, "-")
+
+            # Add icon to index
+            name = f":{icon}:"
+            if not any(name in index[key] for key in ["emoji", "aliases"]):
+                index["emoji"][name] = { "name": name, "path": file }
+
+    # Return index
+    return index