first commit

eawag-rdm · Sep 18, 2024 · 6a8ac5e · 6a8ac5e
commit 6a8ac5e
Show file tree

Hide file tree

Showing 95 changed files with 3,564 additions and 0 deletions.
diff --git a/.github/workflows/build-jupyter-book.yml b/.github/workflows/build-jupyter-book.yml
@@ -0,0 +1,41 @@
+name: Build Jupyter Book
+
+# Trigger this action on push to the main branch
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-jupyter-book:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Checkout the repository
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Set up Python
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+
+    # Install Jupyter Book and dependencies
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install jupyter-book
+
+    # Build the Jupyter Book
+    - name: Build Jupyter Book
+      run: |
+        jupyter-book build --all docs 
+
+    # Upload the build folder as an artifact
+    - name: Upload build folder as artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: eric-documentation 
+        path: ./docs/_build/html  # Adjust the path if your output folder is different
+
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+venv
+_build
+.ipynb_checkpoints
diff --git a/LICENSE b/LICENSE
diff --git a/ReadMe.md b/ReadMe.md
@@ -0,0 +1,21 @@
+# ERIC Documentation
+
+This repository contains the documentation for ERIC/internal and ERIC/open.
+It utilizes Jupyterbook to generate HTML from `.md` and `.ipynb` files.
+
+Follow this [Guide](https://jupyterbook.org/en/stable/start/overview.html) on how to set up your python environment.
+
+To build run:
+```bash
+jupyter-book build --all docs/
+```
+
+## Nice to know
+With this command you can generate gifs from all png files in folder:
+```bash
+convert -delay 150 -loop 0 *.png output.gif
+```
+
+## Known issues
+You might need to copy videos (`.mp4`) to the build directory manually.
+
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,34 @@
+# Book settings
+# Learn more at https://jupyterbook.org/customize/config.html
+
+title: ERIC Documentation
+author: Christian Foerster - rdm@eawag.ch
+logo: _static/images/light_logo.png
+copyright: "2024"
+
+# Force re-execution of notebooks on each build.
+# See https://jupyterbook.org/content/execute.html
+execute:
+  execute_notebooks: force
+
+# Information about where the book exists on the web
+repository:
+  url: https://github.com/eawag-rdm/eric-documentation  # Online location of your book
+  branch: main  # Which branch of the repository should be used when creating links (optional)
+
+# Add GitHub buttons to your book
+# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
+html:
+  favicon: _static/images/favicon-96x96.png
+  home_page_in_navbar: false
+  use_edit_page_button: true
+  use_issues_button: true
+  use_repository_button: true
+
+sphinx:
+  config:
+    html_theme_options: 
+      logo:
+        image_light: _static/images/light_logo.png
+        image_dark: _static/images/dark_logo.png
+
diff --git a/docs/_static/images/about_tab.png b/docs/_static/images/about_tab.png
diff --git a/docs/_static/images/add_data_button.png b/docs/_static/images/add_data_button.png
diff --git a/docs/_static/images/add_package_button.png b/docs/_static/images/add_package_button.png
diff --git a/docs/_static/images/add_readme.gif b/docs/_static/images/add_readme.gif
diff --git a/docs/_static/images/add_resources.gif b/docs/_static/images/add_resources.gif
diff --git a/docs/_static/images/add_resources_later.gif b/docs/_static/images/add_resources_later.gif
diff --git a/docs/_static/images/dark_logo.png b/docs/_static/images/dark_logo.png
diff --git a/docs/_static/images/dummy_address.png b/docs/_static/images/dummy_address.png
diff --git a/docs/_static/images/edit_resources.gif b/docs/_static/images/edit_resources.gif
diff --git a/docs/_static/images/enter_edit.gif b/docs/_static/images/enter_edit.gif
diff --git a/docs/_static/images/eric-internal.png b/docs/_static/images/eric-internal.png
diff --git a/docs/_static/images/eric-open.png b/docs/_static/images/eric-open.png
diff --git a/docs/_static/images/eric-rights-management.mp4 b/docs/_static/images/eric-rights-management.mp4
diff --git a/docs/_static/images/favicon-96x96.png b/docs/_static/images/favicon-96x96.png
diff --git a/docs/_static/images/file_upload_button.png b/docs/_static/images/file_upload_button.png
diff --git a/docs/_static/images/get_data_ready.png b/docs/_static/images/get_data_ready.png
diff --git a/docs/_static/images/info_circle.png b/docs/_static/images/info_circle.png
diff --git a/docs/_static/images/light_logo.png b/docs/_static/images/light_logo.png
diff --git a/docs/_static/images/link-button.png b/docs/_static/images/link-button.png
diff --git a/docs/_static/images/logo_internal.gif b/docs/_static/images/logo_internal.gif
diff --git a/docs/_static/images/logo_open.gif b/docs/_static/images/logo_open.gif
diff --git a/docs/_static/images/navigate_to_package_creation.gif b/docs/_static/images/navigate_to_package_creation.gif
diff --git a/docs/_static/images/organizations_button.png b/docs/_static/images/organizations_button.png
diff --git a/docs/_static/images/packages_button.png b/docs/_static/images/packages_button.png
diff --git a/docs/_static/images/research_group.png b/docs/_static/images/research_group.png
diff --git a/docs/_static/images/resource_fields.png b/docs/_static/images/resource_fields.png
diff --git a/docs/_static/images/save_and_add_another_button.png b/docs/_static/images/save_and_add_another_button.png
diff --git a/docs/_static/images/scroll_package_creation.gif b/docs/_static/images/scroll_package_creation.gif
diff --git a/docs/_static/images/spatial-extend-linestring.png b/docs/_static/images/spatial-extend-linestring.png
diff --git a/docs/_static/images/spatial-extend-multilinestring.png b/docs/_static/images/spatial-extend-multilinestring.png
diff --git a/docs/_static/images/spatial-extend-multipoint.png b/docs/_static/images/spatial-extend-multipoint.png
diff --git a/docs/_static/images/spatial-extend-multipolygon.png b/docs/_static/images/spatial-extend-multipolygon.png
diff --git a/docs/_static/images/spatial-extend-point.png b/docs/_static/images/spatial-extend-point.png
diff --git a/docs/_static/images/spatial-extend-polygon.png b/docs/_static/images/spatial-extend-polygon.png
diff --git a/docs/_static/images/tobias.png b/docs/_static/images/tobias.png
diff --git a/docs/_static/screenshots/add_data/1_add_data.png b/docs/_static/screenshots/add_data/1_add_data.png
diff --git a/docs/_static/screenshots/add_data/2_add_data_marked.png b/docs/_static/screenshots/add_data/2_add_data_marked.png
diff --git a/docs/_static/screenshots/add_data/3_add_resource.png b/docs/_static/screenshots/add_data/3_add_resource.png
diff --git a/docs/_static/screenshots/add_readme/1_add_resource.png b/docs/_static/screenshots/add_readme/1_add_resource.png
diff --git a/docs/_static/screenshots/add_readme/2_add_resource_marked.png b/docs/_static/screenshots/add_readme/2_add_resource_marked.png
diff --git a/docs/_static/screenshots/add_readme/3_upload_readme.png b/docs/_static/screenshots/add_readme/3_upload_readme.png
diff --git a/docs/_static/screenshots/add_readme/4_upload_readme_marked.png b/docs/_static/screenshots/add_readme/4_upload_readme_marked.png
diff --git a/docs/_static/screenshots/add_readme/5-uploaded.png b/docs/_static/screenshots/add_readme/5-uploaded.png
diff --git a/docs/_static/screenshots/add_readme/6-uploaded_marked.png b/docs/_static/screenshots/add_readme/6-uploaded_marked.png
diff --git a/docs/_static/screenshots/add_readme/7-done.png b/docs/_static/screenshots/add_readme/7-done.png
diff --git a/docs/_static/screenshots/create_package_images/1_landing_page.png b/docs/_static/screenshots/create_package_images/1_landing_page.png
diff --git a/docs/_static/screenshots/create_package_images/2_landing_page_marked.png b/docs/_static/screenshots/create_package_images/2_landing_page_marked.png
diff --git a/docs/_static/screenshots/create_package_images/3_packages_page.png b/docs/_static/screenshots/create_package_images/3_packages_page.png
diff --git a/docs/_static/screenshots/create_package_images/4_packages_page_marked.png b/docs/_static/screenshots/create_package_images/4_packages_page_marked.png
diff --git a/docs/_static/screenshots/create_package_images/5_package_add_page.png b/docs/_static/screenshots/create_package_images/5_package_add_page.png
diff --git a/docs/_static/screenshots/edit_package/add_resources/3-edit.png b/docs/_static/screenshots/edit_package/add_resources/3-edit.png
diff --git a/docs/_static/screenshots/edit_package/add_resources/4-edit-marked.png b/docs/_static/screenshots/edit_package/add_resources/4-edit-marked.png
diff --git a/docs/_static/screenshots/edit_package/add_resources/5-add-resources.png b/docs/_static/screenshots/edit_package/add_resources/5-add-resources.png
diff --git a/docs/_static/screenshots/edit_package/add_resources/6-add-resources-marked.png b/docs/_static/screenshots/edit_package/add_resources/6-add-resources-marked.png
diff --git a/docs/_static/screenshots/edit_package/add_resources/7-add-resource.png b/docs/_static/screenshots/edit_package/add_resources/7-add-resource.png
diff --git a/docs/_static/screenshots/edit_package/add_resources_later.gif b/docs/_static/screenshots/edit_package/add_resources_later.gif
diff --git a/docs/_static/screenshots/edit_package/edit_resources.gif b/docs/_static/screenshots/edit_package/edit_resources.gif
diff --git a/docs/_static/screenshots/edit_package/edit_resources/3-edit.png b/docs/_static/screenshots/edit_package/edit_resources/3-edit.png
diff --git a/docs/_static/screenshots/edit_package/edit_resources/4-edit-marked.png b/docs/_static/screenshots/edit_package/edit_resources/4-edit-marked.png
diff --git a/docs/_static/screenshots/edit_package/edit_resources/5-add-resources.png b/docs/_static/screenshots/edit_package/edit_resources/5-add-resources.png
diff --git a/docs/_static/screenshots/edit_package/edit_resources/6-add-resources-marked.png b/docs/_static/screenshots/edit_package/edit_resources/6-add-resources-marked.png
diff --git a/docs/_static/screenshots/edit_package/edit_resources/7-edit-resource.png b/docs/_static/screenshots/edit_package/edit_resources/7-edit-resource.png
diff --git a/docs/_static/screenshots/edit_package/enter_edit.gif b/docs/_static/screenshots/edit_package/enter_edit.gif
diff --git a/docs/_static/screenshots/edit_package/enter_edit/1-package.png b/docs/_static/screenshots/edit_package/enter_edit/1-package.png
diff --git a/docs/_static/screenshots/edit_package/enter_edit/2-package-marked.png b/docs/_static/screenshots/edit_package/enter_edit/2-package-marked.png
diff --git a/docs/_static/screenshots/edit_package/enter_edit/3-edit.png b/docs/_static/screenshots/edit_package/enter_edit/3-edit.png
diff --git a/docs/_static/screenshots/edit_package/enter_edit/4-edit-marked.png b/docs/_static/screenshots/edit_package/enter_edit/4-edit-marked.png
diff --git a/docs/_static/screenshots/logo_internal/1-eric-internal.png b/docs/_static/screenshots/logo_internal/1-eric-internal.png
diff --git a/docs/_static/screenshots/logo_internal/2-eric-internal-marked.png b/docs/_static/screenshots/logo_internal/2-eric-internal-marked.png
diff --git a/docs/_static/screenshots/logo_internal/3-eric-internal-marked.png b/docs/_static/screenshots/logo_internal/3-eric-internal-marked.png
diff --git a/docs/_static/screenshots/logo_open/1-eric-open.png b/docs/_static/screenshots/logo_open/1-eric-open.png
diff --git a/docs/_static/screenshots/logo_open/2-eric-open-marked.png b/docs/_static/screenshots/logo_open/2-eric-open-marked.png
diff --git a/docs/_static/screenshots/logo_open/3-eric-open-marked.png b/docs/_static/screenshots/logo_open/3-eric-open-marked.png
diff --git a/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-07.png b/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-07.png
diff --git a/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-12.png b/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-12.png
diff --git a/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-16.png b/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-16.png
diff --git a/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-20.png b/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-20.png
diff --git a/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-24.png b/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-24.png
diff --git a/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-27.png b/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-27.png
diff --git a/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-30.png b/...creenshots/scroll_package_creation_form/Screenshot from 2024-09-12 14-46-30.png
diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -0,0 +1,15 @@
+# Table of contents
+# Learn more at https://jupyterbook.org/customize/toc.html
+
+format: jb-book
+root: intro
+options:
+  maxdepth: 3
+chapters:
+- file: overview
+- file: quickstart
+- file: publish-a-data-package
+- file: archiving-guide
+- file: examples
+- file: automation
+- file: faq