feelpp / feelpp-project Goto Github PK

View Code? Open in Web Editor NEW

1.0 16.0 3.0 6.88 MB

Feel++ Template Project

Home Page: https://feelpp.github.io/feelpp-project/

Dockerfile 0.01% CMake 0.15% C++ 0.59% Shell 0.11% GLSL 0.07% JavaScript 0.03% Python 0.26% Jupyter Notebook 98.79%

cpp17 feelpp antora asciidoc python python3 feelpp-toolboxes

feelpp-project's Introduction

Feel++ Template Project

This repository provides a basic starting point for a Feel++ application including:

✓ Feel++ applications in C++ to use Feel++ and Feel++ toolboxes in src
✓ documentation using asciidoc and antora
✓ python Feel++ notebooks that can be downloaded from the documentation
✓ continuous integration including tests for the C++ applications
✓ docker image generation for the project

The documentation for feelpp-project is available at here and you can build on it for your project by enabling the github pages for your repository.

Renaming the project

By default the project is named feelpp-project if you cloned the repository feelpp/feelpp-project. However if you used the previous repository as a template, then the project is renamed using the name of the repository using the script rename.sh at the initialization of the repository. If the name does not suit you, you can change it again using the script rename.sh and providing the new name as argument.

Warning

the script rename.sh will rename the project however some url might be set properly if you rename the project yourself. You need to check the following files: docs/site.yml and docs/package.json and fix the urls after the rename process is done.

Updating the feelpp-project version

The version of the project is defined in the files CMakeLists.txt, docs/antora.yml and docs/package.json. You need to update with the same version in all files.

Release process

✓ update the version in CMakeLists.txt
✓ update the version in docs/antora.yml
✓ commit the changes with the message "Release vx.y.z". At this point the CI will generate the docker image and push it to docker hub

feelpp-project's People

Contributors

Stargazers

Watchers

Forkers

master-csmi ggrossetie mfkiwl

feelpp-project's Issues

Fix requirements

Fix requirements.txt and package.json

Add basic documentation in Antora as a starting point

Feel++ projects come with Antora as a documentation system. We should provide a basic documentation to start with, not just some empty files to fill in

update template project

improve antora support

our antora-ui is improving, we need to reflect these changes into Feel++ project template repo

improve navigation
add python examples for feel++
add new configurable home layout

add support for python and jupyter extensions

we have python code we should support python and jupyter docker/vscode devcontainer

Please add an example on how to add new BC keyword

Hi,
@prudhomm @vincentchabannes @romainhild
would it be possible to add an example on how to implement new BC conditions?
I'm thinking of BiotSavart , for instance, to compute Dirichlet conditions from a given formula or a call to a dedicated library.

enable finite element assembly and python bindings

add interface to Laplacian to enable finite element assembly

update antora version and documentation version

add support for python bindings

add support for python bindings
create python wheel
added antora page with a dynamic block

diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index 3c6197a..c5c2f56 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -9,7 +9,7 @@
        },
        // Set *default* container specific settings.json values on container create.
        "settings": {
-               "terminal.integrated.shell.linux": "/bin/bash",
+               "terminal.integrated.defaultProfile.linux": "bash",
                "clangd.arguments": [
                        "--compile-commands-dir=build/",
                        "--all-scopes-completion",
@@ -41,28 +41,21 @@
        // "forwardPorts": [],
        // Use 'postCreateCommand' to run commands after the container is created.
        "postCreateCommand": "uname -a",
-       // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
-       "remoteUser": "vscode",
        "mounts": [
                //"source=${localEnv:HOME}${localEnv:USERPROFILE},target=/host-home-folder,type=bind,consistency=cached"
-//             "source=${localWorkspaceFolder}/app-data,target=/data,type=bind,consistency=cached"
+               //"source=${localWorkspaceFolder}/app-data,target=/data,type=bind,consistency=cached"
        ],
        /*Uncomment the section below to enable GUI support then rebuild the container. A Window with a rotating horse should appear on startup if successful*/
        // "initializeCommand": "echo $(xhost +local:root)",
        "runArgs": [
-               //      "--gpus",
-               //      "all",
-                       "-v",
-               //      "/tmp/.X11-unix:/tmp/.X11-unix",
-               // "--device",
-               // "/dev/snd",
-               //"--cap-add=SYS_PTRACE",
-               //"--security-opt",
-               //"seccomp=unconfined"
+               //      "--gpus", "all",
+               "--cap-add=SYS_PTRACE", 
+           "--security-opt", "seccomp=unconfined",
+        "--net", "host", 
+        "-e", "DISPLAY=${env:DISPLAY}",
+        "-v", "/tmp/.X11-unix:/tmp/.X11-unix"
        ],
-       // "containerEnv": {
-       //      "QT_X11_NO_MITSHM": "1",
-       //      "DISPLAY": "${localEnv:DISPLAY}"
-       // },
        // "postAttachCommand": "sudo ldconfig && echo $(glmark2) &",
+       // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
+       "remoteUser": "feelpp",
 }
\ No newline at end of file

the website
the CI
the packages

This needs to be extended to the recent develop in v3

first triggers at creation of the repo a workflow
then disables the workflow so that it cannot be used anymore

feelpp / feelpp-project Goto Github PK

feelpp-project's Introduction

Feel++ Template Project

Renaming the project

Updating the feelpp-project version

Release process

feelpp-project's People

Contributors

Stargazers

Watchers

Forkers

feelpp-project's Issues

Recommend Projects

Recommend Topics

Recommend Org