Skip to content

Commit

Permalink
"Updated README.md to add links to package documentation and examples"
Browse files Browse the repository at this point in the history
  • Loading branch information
kunle009 committed May 18, 2024
1 parent be742d0 commit ecdeecc
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ This module will be useful in determining:

The project is based mainly on instructions contained in the Eurocode 2
alongside python packages like numpy,plotly,scipy and IndeterminateBeam package. Comprehensive
examples are contained in the examples folder
examples are contained in the examples folder.
The full package documentation can be accessed [here](http://foundationdesign.readthedocs.io/).

Text-based examples of the package presented in the [documentation](http://foundationdesign.readthedocs.io/examples.html) the following examples have been treated thus far [Concentric Pad Foundation](https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Concentric_Footing_Example.ipynb), [Eccentric Pad Foundation](https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Eccentric_Footing_Example.ipynb) and a [Combined Footing Pad Foundation](https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Combined_Footing_Mosley_bungey.ipynb). A web-based graphical user interface (GUI) is currently in development.

## Project Purpose

Expand Down

0 comments on commit ecdeecc

Please sign in to comment.