Skip to content

Commit

Permalink
Initial upload
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Genoe committed Oct 2, 2023
0 parents commit 1ff4c5d
Show file tree
Hide file tree
Showing 11 changed files with 225 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Video Holography

This repository gives an overview of the Video Holography ERC project results.

This repository comprises:
* The web based overview of the [Video Holography ERC project results](https://jangenoe.github.io/VideoHolography)
* The pdf of the [Video Holography ERC project results](https://jangenoe.github.io/VideoHolography/Latex/VideoHolography.pdf)

2 changes: 2 additions & 0 deletions .github/requirements-Book.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
jupyter-book
ghp-import
59 changes: 59 additions & 0 deletions .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: deploy
on:
push:
branches:
- main
jobs:
build-and-deploy-book:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python 3.9
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Install dependencies
run: |
pip install -r .github/requirements-Book.txt
- name: Build the Jupyterbook website
run: |
jb build --all ./files/
- name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./files/_build/html

build-and-deploy-book-pdf:
needs: build-and-deploy-book
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python 3.9
uses: actions/setup-python@v4
with:
python-version: 3.9
- name: Install dependencies
run: |
pip install -r .github/requirements-Book.txt
sudo apt-get -qq update
sudo apt-get install -y \
texlive-latex-recommended \
texlive-latex-extra \
texlive-fonts-extra \
fonts-freefont-otf \
texlive-xetex \
latexmk \
xindy
- name: Build the Jupyterbook pdf
run: |
jb build --builder pdflatex --all files/
mv ./files/_build/latex/python.pdf ./files/_build/latex/VideoHolography.pdf
- name: GitHub Pages action
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./files/_build/latex/
destination_dir: Latex
73 changes: 73 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
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/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Sphinx documentation
docs/_build/
_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# mkdocs documentation
/site

23 changes: 23 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
cff-version: 1.2.0
title: Video Holography ERC project results summary
message: >-
If you use this document, please cite it using the following metadata.
type: document
authors:
- given-names: Jan
family-names: Genoe
email: jan.genoe@imec.be
affiliation: imec and KULeuven
orcid: 'https://orcid.org/0000-0002-4019-5979'
repository-code: >-
https://github.com/jangenoe/VideoHolography
url: >-
https://jangenoe.github.io/VideoHolography/intro.html
keywords:
- holography
- conductive oxides
- CMOS integration
- Metamaterials
- Barium titanate
- Strontium titanate
license: *
1 change: 1 addition & 0 deletions files/VideoHolography.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

37 changes: 37 additions & 0 deletions files/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
title: Video Holography
author: Jan Genoe
logo: images/logo.png
description: Video Holography ERC project results summary
only_build_toc_files: true
repository:
url: https://github.com/jangenoe/VideoHolography
html:
use_issues_button: true
use_edit_page_button: true
use_repository_button: true
execute:
execute_notebooks: "off"
parse:
myst_enable_extensions:
- amsmath
- colon_fence
- dollarmath
- linkify
- substitution
- tasklist
bibtex_bibfiles:
- VideoHolography.bib
sphinx:
config:
html_show_copyright: false
nb_remove_code_source: true
latex_logo: images/logo.png
latex_elements:
extraclassoptions: 'openany,oneside'
papersize: 'a4paper'
preamble: |+
\usepackage{etoolbox}
\AtBeginEnvironment{figure}{\pretocmd{\hyperlink}{\protect}{}{}}
bibtex_reference_style: label
bibtex_default_style : "unsrt"

5 changes: 5 additions & 0 deletions files/_toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
format: jb-book
root: intro
chapters:
- file: intro
- file: bib
10 changes: 10 additions & 0 deletions files/bib.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```{eval-rst}
.. only:: html
Bibliography
============
```

```{bibliography}
:style: unsrt
```
Binary file added files/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions files/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Video Holography


## Introduction


## project results

0 comments on commit 1ff4c5d

Please sign in to comment.