From 8c2805cc278bcf8d8c91c6143cd09aaba86a5699 Mon Sep 17 00:00:00 2001 From: Rostislav Chudoba <rostislav.chudoba@rwth-aachen.de> Date: Wed, 22 Apr 2020 10:03:16 +0200 Subject: [PATCH] Further formatting --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cada503..0284bcd 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,32 @@ # bmcsapps -The repository contains a chain of jupyter notebooks explaining the basic -concepts in the modeling of bond and cracking behavior in brittle-matrix -composites. Jupyter notebooks serve as the top layer of numerical and +## Focus +The repository contains a bundle of jupyter notebooks explaining the basic +concepts needed for modeling of bond and cracking behavior in brittle-matrix +composites. Applications are demonstrated on pullout tests and bending tests +of steel and carbon reinforced concrete composites that have been developed for +different types and scales of reinforcement bridging and pullout actions. +Considered types of reinforcement include long, contiuous bars, textile fabrics, +reinforcing sheets and short fiber. Jupyter notebooks serve as the top layer of numerical and semi-analytical models provided in the BMCS Tool Suite. +## Structure Each notebook contains a theoretical preamble which is accompanied by executable form of the derived formulae expressed within sympy package. Then, numerically executable functions are generated from the symbolic derivation. Large models, including nonlinear finite-element simulations are realized with the help of numpy package. They serve as a basis for interactive -execution of the model providedat the end of the notebooks. The interaction +execution of the model provided at the end of the notebooks. The interaction with the model is implemented using the ipywidget/matplotlib packages. -Prerequisites: The anaconda suite is required for installation. See a -minimum set of required packages in environment.yml file. - -The entry point to the jupyter suite is the index.ipynb notebook. +## Prerequisites +To execute the notebooks locally install the anaconda suite. Required packages +are specified in the environment.yml file. The entry point to the jupyter suite +is the index.ipynb notebook. +## Binder The notebooks can be open also in the clouds without any local installation using the binder service. It takes a while for the repository image to build up. - [](https://mybinder.org/v2/gh/rosoba/bmcsapps.git/master?filepath=index.ipynb) -- GitLab