readme helical
This commit is contained in:
parent
3933d65303
commit
ee33469295
|
@ -2,15 +2,17 @@
|
||||||
# format:
|
# format:
|
||||||
# - source: path/to/markdown/file.md
|
# - source: path/to/markdown/file.md
|
||||||
# target: Wiki-Page-Name
|
# target: Wiki-Page-Name
|
||||||
|
|
||||||
mappings:
|
mappings:
|
||||||
- source: benchmarks/rotatingDrum/readme.md
|
- source: benchmarks/readme.md
|
||||||
target: Performance-of-phasicFlow
|
target: Performance-of-phasicFlow
|
||||||
|
- source: benchmarks/helicalMider/readme.md
|
||||||
|
target: Helical-Mixer-Benchmark
|
||||||
|
- source: benchmarks/rotatingDrum/readme.md
|
||||||
|
target: Rotating-Drum-Benchmark
|
||||||
- source: doc/mdDocs/howToBuild-V1.0.md
|
- source: doc/mdDocs/howToBuild-V1.0.md
|
||||||
target: How-to-build-PhasicFlow‐v‐1.0
|
target: How-to-build-PhasicFlow‐v‐1.0
|
||||||
- source: tutorials/README.md
|
- source: tutorials/README.md
|
||||||
target: Tutorials
|
target: Tutorials
|
||||||
- source: doc/mdDocs/phasicFlowFeatures.md
|
- source: doc/mdDocs/phasicFlowFeatures.md
|
||||||
target: Features-of-PhasicFlow
|
target: Features-of-PhasicFlow
|
||||||
|
|
||||||
# Add more mappings as needed
|
# Add more mappings as needed
|
|
@ -1,6 +1,15 @@
|
||||||
name: Sync-Wiki
|
name: Sync-Wiki
|
||||||
|
|
||||||
on: push
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
paths:
|
||||||
|
- "**/*.md"
|
||||||
|
- ".github/workflows/sync-wiki.yml"
|
||||||
|
- ".github/workflows/markdownList.yml"
|
||||||
|
- ".github/scripts/sync-wiki.py"
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
sync-wiki:
|
sync-wiki:
|
||||||
|
@ -10,14 +19,12 @@ jobs:
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
path: repo
|
path: repo
|
||||||
|
|
||||||
- name: Checkout Wiki
|
- name: Checkout Wiki
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
repository: ${{ github.repository }}.wiki
|
repository: ${{ github.repository }}.wiki
|
||||||
path: wiki
|
path: wiki
|
||||||
continue-on-error: true
|
continue-on-error: true
|
||||||
|
|
||||||
- name: Create Wiki Directory if Not Exists
|
- name: Create Wiki Directory if Not Exists
|
||||||
run: |
|
run: |
|
||||||
if [ ! -d "wiki" ]; then
|
if [ ! -d "wiki" ]; then
|
||||||
|
@ -28,21 +35,17 @@ jobs:
|
||||||
git config user.email "${{ github.actor }}@users.noreply.github.com"
|
git config user.email "${{ github.actor }}@users.noreply.github.com"
|
||||||
git remote add origin "https://github.com/${{ github.repository }}.wiki.git"
|
git remote add origin "https://github.com/${{ github.repository }}.wiki.git"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Set up Python
|
- name: Set up Python
|
||||||
uses: actions/setup-python@v4
|
uses: actions/setup-python@v4
|
||||||
with:
|
with:
|
||||||
python-version: '3.10'
|
python-version: '3.10'
|
||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: pip install pyyaml
|
run: pip install pyyaml
|
||||||
|
|
||||||
- name: Sync markdown files to Wiki
|
- name: Sync markdown files to Wiki
|
||||||
run: |
|
run: |
|
||||||
python $GITHUB_WORKSPACE/repo/.github/scripts/sync-wiki.py
|
python $GITHUB_WORKSPACE/repo/.github/scripts/sync-wiki.py
|
||||||
env:
|
env:
|
||||||
GITHUB_REPOSITORY: ${{ github.repository }}
|
GITHUB_REPOSITORY: ${{ github.repository }}
|
||||||
|
|
||||||
- name: Push changes to wiki
|
- name: Push changes to wiki
|
||||||
run: |
|
run: |
|
||||||
cd wiki
|
cd wiki
|
||||||
|
@ -50,7 +53,7 @@ jobs:
|
||||||
git config user.email "${{ github.actor }}@users.noreply.github.com"
|
git config user.email "${{ github.actor }}@users.noreply.github.com"
|
||||||
git add .
|
git add .
|
||||||
if git status --porcelain | grep .; then
|
if git status --porcelain | grep .; then
|
||||||
git commit -m "Auto sync wiki from main repository"
|
git commit -m "Auto sync wiki from main repository"
|
||||||
git push --set-upstream https://${{ github.actor }}:${{ github.token }}@github.com/${{ github.repository }}.wiki.git master -f
|
git push --set-upstream https://${{ github.actor }}:${{ github.token }}@github.com/${{ github.repository }}.wiki.git master -f
|
||||||
else
|
else
|
||||||
echo "No changes to commit"
|
echo "No changes to commit"
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
# Helical Mixer Benchmark (phasicFlow v-1.0)
|
|
@ -0,0 +1,7 @@
|
||||||
|
|
||||||
|
# Benchmarks
|
||||||
|
|
||||||
|
Benchmakrs has been done on two different simulations: a simulation with simple geometry (rotating drum) and a simulation with complex geometry (helical mixer).
|
||||||
|
|
||||||
|
- [rotating drum](./rotatingDrum/readme.md)
|
||||||
|
- [helical mixer](./helicalMixer/readme.md)
|
Loading…
Reference in New Issue