diff --git a/config/_default/hugo.toml b/config/_default/hugo.toml new file mode 100644 index 00000000000..0fd6090b282 --- /dev/null +++ b/config/_default/hugo.toml @@ -0,0 +1,124 @@ +# Hugo configuration for preCICE website +baseURL = "https://precice.org/" +locale = "en-us" +title = "preCICE - The Coupling Library" +enableGitInfo = true + +[params] +repository = "precice/precice.github.io" +output = "web" +topnav_title = "preCICE" +site_title = "preCICE - The Coupling Library" +company_name = "preCICE" +github_editme_path = "https://github.com/precice/precice.github.io/edit/master/" +google_analytics = "" +description = "preCICE is an open-source coupling library and ecosystem for general partitioned multi-physics and multi-scale simulations, including surface and volume coupling." +sidebars = ["home_sidebar", "docs_sidebar", "tutorial_sidebar", "community_sidebar"] +precice_version = "3.4.1" +calculix_version = "2.20" +calculix_adapter_version = "2.20.1" +matrix_url = "https://matrix.to/#/#precice_lobby:gitter.im?web-instance[element.io]=app.gitter.im" +precice_v1_citations = 451 +precice_v1_citations_url = "https://scholar.google.com/scholar?cites=5053469347483527186&as_sdt=2005&sciodt=0,5&hl=en" +precice_v2_citations = 233 +precice_v2_citations_url = "https://scholar.google.com/scholar?oi=bibs&hl=en&cites=17974677460269868025,12004404035922881061" + +[params.algolia] +application_id = "LIT6P0EW26" +index_name = "jekyll" +search_only_api_key = "760ed6be3e165d08b4a798ac4aa82fe4" +nodes_to_index = "p,code,table" +max_record_size = 20000 + +[params.mermaid] +src = "https://cdn.jsdelivr.net/npm/mermaid@11.12.3/dist/mermaid.min.js" + +[params.github_editme_paths] +"content" = "https://github.com/precice/precice.github.io/edit/master/" +"imported/aste" = "https://github.com/precice/aste/edit/develop/" +"imported/calculix-adapter" = "https://github.com/precice/calculix-adapter/edit/develop/" +"imported/code_aster-adapter" = "https://github.com/precice/code_aster-adapter/edit/develop/" +"imported/dealii-adapter" = "https://github.com/precice/dealii-adapter/edit/develop/" +"imported/dumux-adapter" = "https://github.com/precice/dumux-adapter/edit/develop/" +"imported/dune-adapter" = "https://github.com/precice/dune-adapter/edit/main/" +"imported/fenics-adapter" = "https://github.com/precice/fenics-adapter/edit/develop/" +"imported/fenicsx-adapter" = "https://github.com/precice/fenicsx-adapter/edit/develop/" +"imported/fmi-runner" = "https://github.com/precice/fmi-runner/edit/main/" +"imported/micro-manager" = "https://github.com/precice/micro-manager/edit/develop/" +"imported/openfoam-adapter" = "https://github.com/precice/openfoam-adapter/edit/develop/" +"imported/preeco-orga" = "https://github.com/precice/preeco-orga/edit/main/" +"imported/su2-adapter" = "https://github.com/precice/su2-adapter/edit/develop/" +"imported/tutorials" = "https://github.com/precice/tutorials/edit/develop/" + +[security] +allowContent = [".*"] + +[params.jekyll_defaults."content"] +layout = "page" +comments = false +search = true +sidebar = "home_sidebar" +topnav = "topnav" + +[params.jekyll_defaults."content/docs"] +layout = "page" +comments = false +search = true +sidebar = "docs_sidebar" +topnav = "topnav" +toc = true + +[params.jekyll_defaults."content/tutorials"] +layout = "page" +comments = false +search = true +sidebar = "tutorial_sidebar" +topnav = "topnav" +toc = true + +[params.jekyll_defaults."content/community"] +layout = "page" +comments = false +search = true +sidebar = "community_sidebar" +topnav = "topnav" +toc = true + +[params.jekyll_defaults."imported/docs"] +layout = "page" +comments = false +search = true +sidebar = "docs_sidebar" +topnav = "topnav" +toc = true + +[params.jekyll_defaults."imported/tutorials"] +layout = "page" +comments = false +search = true +sidebar = "tutorial_sidebar" +topnav = "topnav" +toc = true + +[params.jekyll_defaults."imported/preeco-orga"] +layout = "page" +comments = false +search = true +sidebar = "community_sidebar" +topnav = "topnav" +toc = true + +[markup.goldmark.renderer] +unsafe = true + +[markup.highlight] +noClasses = false + +[markup.tableOfContents] +startLevel = 2 +endLevel = 4 +ordered = false + +[outputs] +section = ["HTML"] + diff --git a/config/_default/module.toml b/config/_default/module.toml new file mode 100644 index 00000000000..9f98781168f --- /dev/null +++ b/config/_default/module.toml @@ -0,0 +1,529 @@ +[[mounts]] +source = "_data" +target = "data" + +# Read the existing website content while excluding Jekyll's homepage, which +# Hugo would otherwise interpret as a leaf bundle at the content root. +[[mounts]] +source = "content" +target = "content" +files = ["! index.html"] + +[[mounts]] +source = "faq.html" +target = "content/faq/_index.html" + +[[mounts]] +source = "collections/_publications" +target = "content/publications" + +[[mounts]] +source = "collections/_testimonials" +target = "content/testimonials" + +# Reuse the existing site styles while the Hugo layouts are still minimal. +[[mounts]] +source = "css" +target = "static/css" + +[[mounts]] +source = "js" +target = "static/js" + +[[mounts]] +source = "assets" +target = "static/assets" + +[[mounts]] +source = "images" +target = "static/images" + +[[mounts]] +source = "fonts" +target = "static/fonts" + +[[mounts]] +source = "webfonts" +target = "static/webfonts" + +# CalculiX adapter +[[mounts]] +source = "imported/calculix-adapter/docs/adapter-calculix-overview.md" +target = "content/docs/adapters/calculix/_index.md" + +[[mounts]] +source = "imported/calculix-adapter/docs" +target = "content/docs/adapters/calculix" +files = ["! adapter-calculix-overview.md"] + +# code_aster adapter +[[mounts]] +source = "imported/code_aster-adapter/docs/adapter-code_aster.md" +target = "content/docs/adapters/code_aster/_index.md" + +[[mounts]] +source = "imported/code_aster-adapter/docs/images" +target = "content/docs/adapters/code_aster/images" + +[[mounts]] +source = "imported/code_aster-adapter/docs/thesis-excerpt-cheung.pdf" +target = "content/docs/adapters/code_aster/thesis-excerpt-cheung.pdf" + +# deal.II adapter +[[mounts]] +source = "imported/dealii-adapter/docs/adapter-dealii-overview.md" +target = "content/docs/adapters/dealii/_index.md" + +[[mounts]] +source = "imported/dealii-adapter/docs" +target = "content/docs/adapters/dealii" +files = ["! adapter-dealii-overview.md"] + +# DuMuX adapter +[[mounts]] +source = "imported/dumux-adapter/docs/overview.md" +target = "content/docs/adapters/dumux/_index.md" + +[[mounts]] +source = "imported/dumux-adapter/docs" +target = "content/docs/adapters/dumux" +files = ["! overview.md"] + +# DUNE adapter +[[mounts]] +source = "imported/dune-adapter/docs/overview.md" +target = "content/docs/adapters/dune/_index.md" + +# FEniCS adapter +[[mounts]] +source = "imported/fenics-adapter/docs/adapter-fenics.md" +target = "content/docs/adapters/fenics/_index.md" + +[[mounts]] +source = "imported/fenics-adapter/docs" +target = "content/docs/adapters/fenics" +files = ["! adapter-fenics.md", "! ReleaseGuide.md"] + +# FEniCSx adapter +[[mounts]] +source = "imported/fenicsx-adapter/docs/README.md" +target = "content/docs/adapters/fenicsx/_index.md" + +# OpenFOAM adapter +[[mounts]] +source = "imported/openfoam-adapter/docs/README.md" +target = "content/docs/adapters/openfoam/_index.md" + +[[mounts]] +source = "imported/openfoam-adapter/docs" +target = "content/docs/adapters/openfoam" +files = ["! README.md", "! images/docs-adapter-openfoam-implicit-loop-src.md"] + +# SU2 adapter +[[mounts]] +source = "imported/su2-adapter/docs/overview.md" +target = "content/docs/adapters/su2/_index.md" + +[[mounts]] +source = "imported/su2-adapter/docs" +target = "content/docs/adapters/su2" +files = ["! overview.md"] + +# ASTE +[[mounts]] +source = "imported/aste/docs/README.md" +target = "content/docs/tooling/aste/_index.md" + +# FMI runner +[[mounts]] +source = "imported/fmi-runner/docs/README.md" +target = "content/docs/tooling/fmi-runner/_index.md" + +[[mounts]] +source = "imported/fmi-runner/docs/images" +target = "content/docs/tooling/fmi-runner/images" + +# Micro Manager +[[mounts]] +source = "imported/micro-manager/docs/README.md" +target = "content/docs/tooling/micro-manager/_index.md" + +[[mounts]] +source = "imported/micro-manager/docs" +target = "content/docs/tooling/micro-manager" +files = ["! README.md", "! ReleaseGuide.md"] + +# preECO guidelines +[[mounts]] +source = "imported/preeco-orga/guidelines/guidelines-adapters.md" +target = "content/community/contribute/guidelines/_index.md" + +[[mounts]] +source = "imported/preeco-orga/guidelines" +target = "content/community/contribute/guidelines" +files = ["! guidelines-adapters.md"] + +# Tutorial: aste turbine +[[mounts]] +source = "imported/tutorials/aste-turbine/README.md" +target = "content/tutorials/aste-turbine/_index.md" + +[[mounts]] +source = "imported/tutorials/aste-turbine/images" +target = "content/tutorials/aste-turbine/images" + +# Tutorial: breaking dam 2d +[[mounts]] +source = "imported/tutorials/breaking-dam-2d/README.md" +target = "content/tutorials/breaking-dam-2d/_index.md" + +[[mounts]] +source = "imported/tutorials/breaking-dam-2d/images" +target = "content/tutorials/breaking-dam-2d/images" + +# Tutorial: channel transport +[[mounts]] +source = "imported/tutorials/channel-transport/README.md" +target = "content/tutorials/channel-transport/_index.md" + +[[mounts]] +source = "imported/tutorials/channel-transport/images" +target = "content/tutorials/channel-transport/images" + +# Tutorial: channel transport particles +[[mounts]] +source = "imported/tutorials/channel-transport-particles/README.md" +target = "content/tutorials/channel-transport-particles/_index.md" + +[[mounts]] +source = "imported/tutorials/channel-transport-particles/images" +target = "content/tutorials/channel-transport-particles/images" + +# Tutorial: channel transport reaction +[[mounts]] +source = "imported/tutorials/channel-transport-reaction/README.md" +target = "content/tutorials/channel-transport-reaction/_index.md" + +[[mounts]] +source = "imported/tutorials/channel-transport-reaction/images" +target = "content/tutorials/channel-transport-reaction/images" + +# Tutorial: elastic tube 1d +[[mounts]] +source = "imported/tutorials/elastic-tube-1d/README.md" +target = "content/tutorials/elastic-tube-1d/_index.md" + +[[mounts]] +source = "imported/tutorials/elastic-tube-1d/images" +target = "content/tutorials/elastic-tube-1d/images" + +# Tutorial: elastic tube 3d +[[mounts]] +source = "imported/tutorials/elastic-tube-3d/README.md" +target = "content/tutorials/elastic-tube-3d/_index.md" + +[[mounts]] +source = "imported/tutorials/elastic-tube-3d/images" +target = "content/tutorials/elastic-tube-3d/images" + +# Tutorial: flow around controlled moving cylinder +[[mounts]] +source = "imported/tutorials/flow-around-controlled-moving-cylinder/README.md" +target = "content/tutorials/flow-around-controlled-moving-cylinder/_index.md" + +[[mounts]] +source = "imported/tutorials/flow-around-controlled-moving-cylinder/images" +target = "content/tutorials/flow-around-controlled-moving-cylinder/images" + +# Tutorial: flow over heated plate +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate/README.md" +target = "content/tutorials/flow-over-heated-plate/_index.md" + +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate/images" +target = "content/tutorials/flow-over-heated-plate/images" + +# Tutorial: flow over heated plate nearest projection +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-nearest-projection/README.md" +target = "content/tutorials/flow-over-heated-plate-nearest-projection/_index.md" + +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-nearest-projection/images" +target = "content/tutorials/flow-over-heated-plate-nearest-projection/images" + +# Tutorial: flow over heated plate partitioned flow +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-partitioned-flow/README.md" +target = "content/tutorials/flow-over-heated-plate-partitioned-flow/_index.md" + +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-partitioned-flow/images" +target = "content/tutorials/flow-over-heated-plate-partitioned-flow/images" + +# Tutorial: flow over heated plate steady state +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-steady-state/README.md" +target = "content/tutorials/flow-over-heated-plate-steady-state/_index.md" + +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-steady-state/images" +target = "content/tutorials/flow-over-heated-plate-steady-state/images" + +# Tutorial: flow over heated plate two meshes +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-two-meshes/README.md" +target = "content/tutorials/flow-over-heated-plate-two-meshes/_index.md" + +[[mounts]] +source = "imported/tutorials/flow-over-heated-plate-two-meshes/images" +target = "content/tutorials/flow-over-heated-plate-two-meshes/images" + +# Tutorial: free flow over porous media +[[mounts]] +source = "imported/tutorials/free-flow-over-porous-media/README.md" +target = "content/tutorials/free-flow-over-porous-media/_index.md" + +[[mounts]] +source = "imported/tutorials/free-flow-over-porous-media/images" +target = "content/tutorials/free-flow-over-porous-media/images" + +# Tutorial: heat exchanger +[[mounts]] +source = "imported/tutorials/heat-exchanger/README.md" +target = "content/tutorials/heat-exchanger/_index.md" + +[[mounts]] +source = "imported/tutorials/heat-exchanger/images" +target = "content/tutorials/heat-exchanger/images" + +# Tutorial: heat exchanger simplified +[[mounts]] +source = "imported/tutorials/heat-exchanger-simplified/README.md" +target = "content/tutorials/heat-exchanger-simplified/_index.md" + +[[mounts]] +source = "imported/tutorials/heat-exchanger-simplified/images" +target = "content/tutorials/heat-exchanger-simplified/images" + +# Tutorial: multiple perpendicular flaps +[[mounts]] +source = "imported/tutorials/multiple-perpendicular-flaps/README.md" +target = "content/tutorials/multiple-perpendicular-flaps/_index.md" + +[[mounts]] +source = "imported/tutorials/multiple-perpendicular-flaps/images" +target = "content/tutorials/multiple-perpendicular-flaps/images" + +# Tutorial: oscillator +[[mounts]] +source = "imported/tutorials/oscillator/README.md" +target = "content/tutorials/oscillator/_index.md" + +[[mounts]] +source = "imported/tutorials/oscillator/images" +target = "content/tutorials/oscillator/images" + +# Tutorial: oscillator overlap +[[mounts]] +source = "imported/tutorials/oscillator-overlap/README.md" +target = "content/tutorials/oscillator-overlap/_index.md" + +[[mounts]] +source = "imported/tutorials/oscillator-overlap/images" +target = "content/tutorials/oscillator-overlap/images" + +# Tutorial: partitioned backwards facing step +[[mounts]] +source = "imported/tutorials/partitioned-backwards-facing-step/README.md" +target = "content/tutorials/partitioned-backwards-facing-step/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-backwards-facing-step/images" +target = "content/tutorials/partitioned-backwards-facing-step/images" + +# Tutorial: partitioned burgers 1d +[[mounts]] +source = "imported/tutorials/partitioned-burgers-1d/README.md" +target = "content/tutorials/partitioned-burgers-1d/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-burgers-1d/images" +target = "content/tutorials/partitioned-burgers-1d/images" + +# Tutorial: partitioned elastic beam +[[mounts]] +source = "imported/tutorials/partitioned-elastic-beam/README.md" +target = "content/tutorials/partitioned-elastic-beam/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-elastic-beam/images" +target = "content/tutorials/partitioned-elastic-beam/images" + +# Tutorial: partitioned heat conduction +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction/README.md" +target = "content/tutorials/partitioned-heat-conduction/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction/images" +target = "content/tutorials/partitioned-heat-conduction/images" + +# Tutorial: partitioned heat conduction 3d +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-3d/README.md" +target = "content/tutorials/partitioned-heat-conduction-3d/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-3d/images" +target = "content/tutorials/partitioned-heat-conduction-3d/images" + +# Tutorial: partitioned heat conduction complex +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-complex/README.md" +target = "content/tutorials/partitioned-heat-conduction-complex/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-complex/images" +target = "content/tutorials/partitioned-heat-conduction-complex/images" + +# Tutorial: partitioned heat conduction direct +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-direct/README.md" +target = "content/tutorials/partitioned-heat-conduction-direct/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-direct/images" +target = "content/tutorials/partitioned-heat-conduction-direct/images" + +# Tutorial: partitioned heat conduction overlap +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-overlap/README.md" +target = "content/tutorials/partitioned-heat-conduction-overlap/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-heat-conduction-overlap/images" +target = "content/tutorials/partitioned-heat-conduction-overlap/images" + +# Tutorial: partitioned pipe +[[mounts]] +source = "imported/tutorials/partitioned-pipe/README.md" +target = "content/tutorials/partitioned-pipe/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-pipe/images" +target = "content/tutorials/partitioned-pipe/images" + +# Tutorial: partitioned pipe multiscale +[[mounts]] +source = "imported/tutorials/partitioned-pipe-multiscale/README.md" +target = "content/tutorials/partitioned-pipe-multiscale/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-pipe-multiscale/images" +target = "content/tutorials/partitioned-pipe-multiscale/images" + +# Tutorial: partitioned pipe two phase +[[mounts]] +source = "imported/tutorials/partitioned-pipe-two-phase/README.md" +target = "content/tutorials/partitioned-pipe-two-phase/_index.md" + +[[mounts]] +source = "imported/tutorials/partitioned-pipe-two-phase/images" +target = "content/tutorials/partitioned-pipe-two-phase/images" + +# Tutorial: perpendicular flap +[[mounts]] +source = "imported/tutorials/perpendicular-flap/README.md" +target = "content/tutorials/perpendicular-flap/_index.md" + +[[mounts]] +source = "imported/tutorials/perpendicular-flap/images" +target = "content/tutorials/perpendicular-flap/images" + +# Tutorial: perpendicular flap stress +[[mounts]] +source = "imported/tutorials/perpendicular-flap-stress/README.md" +target = "content/tutorials/perpendicular-flap-stress/_index.md" + +[[mounts]] +source = "imported/tutorials/perpendicular-flap-stress/images" +target = "content/tutorials/perpendicular-flap-stress/images" + +# Tutorial: quickstart +[[mounts]] +source = "imported/tutorials/quickstart/README.md" +target = "content/tutorials/quickstart/_index.md" + +[[mounts]] +source = "imported/tutorials/quickstart/images" +target = "content/tutorials/quickstart/images" + +# Tutorial: resonant circuit +[[mounts]] +source = "imported/tutorials/resonant-circuit/README.md" +target = "content/tutorials/resonant-circuit/_index.md" + +[[mounts]] +source = "imported/tutorials/resonant-circuit/images" +target = "content/tutorials/resonant-circuit/images" + +# Tutorial: turek hron fsi3 +[[mounts]] +source = "imported/tutorials/turek-hron-fsi3/README.md" +target = "content/tutorials/turek-hron-fsi3/_index.md" + +[[mounts]] +source = "imported/tutorials/turek-hron-fsi3/images" +target = "content/tutorials/turek-hron-fsi3/images" + +# Tutorial: two scale heat conduction +[[mounts]] +source = "imported/tutorials/two-scale-heat-conduction/README.md" +target = "content/tutorials/two-scale-heat-conduction/_index.md" + +[[mounts]] +source = "imported/tutorials/two-scale-heat-conduction/images" +target = "content/tutorials/two-scale-heat-conduction/images" + +# Tutorial: volume coupled diffusion +[[mounts]] +source = "imported/tutorials/volume-coupled-diffusion/README.md" +target = "content/tutorials/volume-coupled-diffusion/_index.md" + +[[mounts]] +source = "imported/tutorials/volume-coupled-diffusion/images" +target = "content/tutorials/volume-coupled-diffusion/images" + +# Tutorial: volume coupled flow +[[mounts]] +source = "imported/tutorials/volume-coupled-flow/README.md" +target = "content/tutorials/volume-coupled-flow/_index.md" + +[[mounts]] +source = "imported/tutorials/volume-coupled-flow/images" +target = "content/tutorials/volume-coupled-flow/images" + +# Tutorial: water hammer +[[mounts]] +source = "imported/tutorials/water-hammer/README.md" +target = "content/tutorials/water-hammer/_index.md" + +[[mounts]] +source = "imported/tutorials/water-hammer/images" +target = "content/tutorials/water-hammer/images" + +# Tutorial: wolf sheep soil creep +[[mounts]] +source = "imported/tutorials/wolf-sheep-soil-creep/README.md" +target = "content/tutorials/wolf-sheep-soil-creep/_index.md" + +[[mounts]] +source = "imported/tutorials/wolf-sheep-soil-creep/images" +target = "content/tutorials/wolf-sheep-soil-creep/images" + +# Tutorials system tests +[[mounts]] +source = "imported/tutorials/tools/tests/README.md" +target = "content/docs/dev-docs/system-tests/_index.md"