Skip to content
Snippets Groups Projects
Commit cba2cc85 authored by Leon Keim's avatar Leon Keim
Browse files

Revert "Merge branch 'doc-dunemodule' into 'master'"

This reverts merge request !243
parent 50c1e44f
No related branches found
No related tags found
1 merge request!249Revert "Merge branch 'doc-dunemodule' into 'master'"
Pipeline #46815 passed
...@@ -7,6 +7,7 @@ This is the suggested ...@@ -7,6 +7,7 @@ This is the suggested
workflow to develop code on top of DuMuX. workflow to develop code on top of DuMuX.
### Task 1: Create new dune module ### Task 1: Create new dune module
<hr>
* Execute the following command (bash environment) in the top-folder, i.e. above the dumux folder * Execute the following command (bash environment) in the top-folder, i.e. above the dumux folder
...@@ -20,18 +21,21 @@ workflow to develop code on top of DuMuX. ...@@ -20,18 +21,21 @@ workflow to develop code on top of DuMuX.
* a version at your choice (the version of your project, not of dumux.) * a version at your choice (the version of your project, not of dumux.)
* your email address * your email address
<br><br><br>
### Task 2: Rerun dunecontrol to configure your new project ### Task 2: Rerun dunecontrol to configure your new project
<hr>
The following command will configure your new module The following command will configure your new module
```bash ```bash
./dune-common/bin/dunecontrol --opts=dumux/cmake.opts --only=<module-name> all ./dune-common/bin/dunecontrol --opts=<opts file> --only=dumux-example all
``` ```
You need to run this command in the folder with content dumux, dumux-course, dune-common, dune-geometry, dune-grid, dune-istl, etc. `<module-name>` needs to be replaced (please replace the angle brackets also) by the name of the module, e.g., by `dumux-example`. You need to run this command in the folder with content dumux, dumux-course, dune-common, dune-geometry, dune-grid, dune-istl, etc. `<opts file>` needs to be replaced (please replace the angle brackets also) by an options file, e.g., by `./dumux/cmake.opts`. Have a look at the comments in this file to see how you can adapt it to your needs.
<br><br><br>
### Task 3: Create a new test case within your new DuMuX module ### Task 3: Create a new test case within your new DuMuX module
<hr>
* Create a new folder (in your module folder), e.g., `appl` * Create a new folder (in your module folder), e.g., `appl`
...@@ -73,9 +77,9 @@ cd appl ...@@ -73,9 +77,9 @@ cd appl
./test_1p_compressible_stationary_tpfa params.input ./test_1p_compressible_stationary_tpfa params.input
``` ```
<br><br><br>
### Task 4: Create a new GitLab project ### Task 4: Create a new GitLab project
<hr>
* Login with your username and password at https://git.iws.uni-stuttgart.de/ * Login with your username and password at https://git.iws.uni-stuttgart.de/
...@@ -88,27 +92,17 @@ your own project. ...@@ -88,27 +92,17 @@ your own project.
* Then choose to **Create blank project**. * Then choose to **Create blank project**.
* Specify your project name, e.g., <module-name>, untick the box *Initialize repository with a README* and click the **Create project** button. * Specify your project name, untick the box *Initialize repository with a README* and click the **Create project** button.
* Follow the given instructions for an *existing folder*. * Follow the given instructions for an *existing folder*.
Hint: if you have not done so already, be sure to inform your computer of your git account with the following commands: Hint: if you have not done so already, be sure to inform your computer of your git account with the following commands:
```bash ```bash
cd <module-name>
git config --global user.name "FIRST_NAME LAST_NAME" git config --global user.name "FIRST_NAME LAST_NAME"
git config --global user.email "YOUR_EMAIL_ADDRESS" git config --global user.email "YOUR_EMAIL_ADDRESS"
git init --initial-branch=main
git remote add origin https://git.iws.uni-stuttgart.de/<Namespace>/<module-name>.git
``` ```
**Important**: Before executing the `git add .` command, you should add your cmake build folder to `.gitignore`. **Important**: Before executing the `git add .` command, you should add your cmake build folder to `.gitignore`.
The easiest way to do so is to copy the `.gitignore` file from the dumux module into your module path. If everything The easiest way to do so is to copy the `.gitignore` file from the dumux module into your module path. If everything
worked, executing `git status` should not show `build-cmake` anymore. Never put your executables or other build files worked, executing `git status` should not show `build-cmake` anymore. Never put your executables or other build files
under version control. Only source files (`*.hh`, `*.cc`, `*.input`, `CMakeLists.txt`) should be under version control. under version control. Only source files (`*.hh`, `*.cc`, `*.input`, `CMakeLists.txt`) should be under version control.
Then you can commit and push your new module to your repository:
```bash
git add .
git commit -m "Initial commit"
git push -u origin main
```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment