Skip to content
Snippets Groups Projects
Select Git revision
  • 24a961001509e5d25bcbd59f706799f824b69151
  • develop default protected
  • feature/kinetic-schemes
  • feature/reconstruction
  • feature/local-dt-fsi
  • feature/composite-scheme-sources
  • feature/composite-scheme-other-fluxes
  • feature/serraille
  • feature/variational-hydro
  • feature/composite-scheme
  • hyperplastic
  • feature/polynomials
  • feature/gks
  • feature/implicit-solver-o2
  • feature/coupling_module
  • feature/implicit-solver
  • feature/merge-local-dt-fsi
  • master protected
  • feature/escobar-smoother
  • feature/hypoelasticity-clean
  • feature/hypoelasticity
  • v0.5.0 protected
  • v0.4.1 protected
  • v0.4.0 protected
  • v0.3.0 protected
  • v0.2.0 protected
  • v0.1.0 protected
  • Kidder
  • v0.0.4 protected
  • v0.0.3 protected
  • v0.0.2 protected
  • v0 protected
  • v0.0.1 protected
33 results

README.md-template

Blame
  • README.md-template 1.84 KiB
    `pugs`'s plugin `_PLUGIN_NAME_`
    ===============================
    
    # Building `_PLUGIN_NAME_`
    
    ## `pugs` installation
    
    Building this plugin requires an **installed** version of `pugs`.
    `pugs` follows standard `cmake` installation recipes.
    
    Before building `pugs` one should define its installation directory.
    In the `pugs` compilation directory one should execute
    ```shell
    cmake -DCMAKE_INSTALL_PREFIX=pugs_install_dir ...
    ```
    where `pugs_install_dir` is the chosen installation directory.
    
    Then one simply runs
    ```shell
    make install
    ```
    
    ## building the plugin `_PLUGIN_NAME_`
    
    > **Warning**:<br>
    > Building `_PLUGIN_NAME_` in its source directory is
    > **forbidden**. Trying to do so will result in a failure. However it
    > generally leaves some garbage files in the source directory, namely
    > the `CMakeCache.txt` and the `CMakeFiles` directory. `CMake` itself
    > is not able to remove them, to avoid the risk of compilation issues,
    > one has to dot it manually...
    
    In the build directory one runs
    ```shell
    PUGS_INSTALL_DIR=pugs_install_dir cmake _PLUGIN_LOW__dir
    ```
    where `pugs_install_dir` has the same value as above and `_PLUGIN_LOW__dir`
    is the directory that contains this `README.md` file.
    
    Then to build the plugin, one runs
    ```shell
    make
    ```
    
    If anything runs fine, the dynamic library `lib_PLUGIN_NAME_.so` is
    built.
    
    # Using `_PLUGIN_NAME_`
    
    In order to use the created plugin, one simply has to give the
    location of `lib_PLUGIN_NAME_.so` to `pugs`. This is done by means of
    environment variables. There are two possibilities:
    - `PUGS_PLUGIN` contains a semicolumn separated list of plugin
      libraries,
    - `PUGS_PLUGIN_DIR` contains a semicolumn separated list of path to
      plugin libraries.
    
    Example
    ```shell
    export PUGS_PLUGIN="/pathtoplugin/lib_PLUGIN_NAME_.so"
    ```
    or
    ```shell
    export PUGS_PLUGIN_DIR="/pathtoplugin1;/pathtoplugin2"
    ```
    
    Then one launches `pugs` classically.