Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Mohanad Albughdadi authored and Mohanad Albughdadi committed May 27, 2024
0 parents commit 809dfe8
Show file tree
Hide file tree
Showing 53 changed files with 4,066 additions and 0 deletions.
48 changes: 48 additions & 0 deletions .github/workflows/deploy-book.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: deploy-book

on:
push:
branches:
- main
paths:
- docs/**

jobs:
deploy-book:
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
steps:
- uses: actions/checkout@v3

- name: Set up Python 3.11
uses: actions/setup-python@v4
with:
python-version: '3.11'

- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Cache executed notebooks
uses: actions/cache@v3
with:
path: docs/_build/.jupyter_cache
key: jupyter-book-cache-${{ hashFiles('requirements.txt') }}

- name: Build the book
run: |
jupyter-book build docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: "docs/_build/html"

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

30 changes: 30 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
other_data
lai
T31TCJ_20220905T105619_stack.*
*.tif
patch*.txt
# Ignore Python cache directories
__pycache__/
.DS_Store
# Ignore other typical Python artifacts
*.pyc
*.pyo
*.pyd
*.pdb
*.egg-info/
*.eggs/
*.env/
*.venv/
ENV/
env/
venv/
.venv/

# Ignore Jupyter Notebook checkpoints
.ipynb_checkpoints/

# Ignore virtual environment directories
venv/
ENV/
env/
.venv/
9 changes: 9 additions & 0 deletions .pylintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[MASTER]
init-hook='import sys; sys.path.append("./src")'
extension-pkg-whitelist=pydantic
disable=
C0114, # missing-module-docstring
C0115, # missing-class-docstring
C0116, # missing-function-docstring
C0301, # line-too-long
C0302, # too-many-line
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# EO4EU IGARSS 2024 TUTORIAL
32 changes: 32 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html

title: EO4EU IGARSS 2024
author: EO4EU
logo: figures/eo4eu-logo.png

# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: off

# Define the name of the latex output file for PDF builds
latex:
latex_documents:
targetname: book.tex

# Add a bibtex file so that we can create citations
# bibtex_bibfiles:
# - references.bib

# Information about where the book exists on the web
repository:
url: https://github.com/executablebooks/jupyter-book # Online location of your book
path_to_book: docs # Optional path to your book, relative to the repository root
branch: master # 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:
use_issues_button: true
use_repository_button: true
9 changes: 9 additions & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Table of contents
# Learn more at https://jupyterbook.org/customize/toc.html

format: jb-book
root: eo4eu_intro
chapters:
- file: processing_apis
- file: crop_monitoring
- file: object_detection
Loading

0 comments on commit 809dfe8

Please sign in to comment.