.. FoundationDesign documentation master file, created by
   sphinx-quickstart on Sat May  4 21:52:31 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to FoundationDesign's documentation!
============================================
.. image:: https://img.shields.io/pypi/v/FoundationDesign
   :alt: PyPI - Version
.. image:: https://img.shields.io/pypi/l/FoundationDesign
   :alt: PyPI - License
.. image:: https://static.pepy.tech/badge/foundationdesign
   :alt: PEPY - downloads
.. image:: https://static.pepy.tech/badge/foundationdesign/month
   :alt: PEPY - downloads-month
.. image:: https://github.com/kunle009/FoundationDesign/actions/workflows/build-and-test.yml/badge.svg?branch=main
   :alt: build-and-test


``FoundationDesign`` FoundationDesign is a python module to be used for the design and analysis
of different foundation types in accordance to the Eurocode 2.
This project is an attempt to have a free standalone python package that can
be used to analyse and design foundations with results as good as paid softwares.
This module will be useful in determining:

   - The critical bending moments in the foundation
   - Critical shear force in the foundation
   - Transverse shear check of the foundation
   - Sliding checks
   - Crack width checks
   - Reinforcement provisions
   - Punching shear checks etc


The ``FoundationDesign`` `package repository <https://github.com/kunle009/FoundationDesign>`_ can be found on Github and is ready for installation using `pip`. 

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   installation

.. toctree::
   :maxdepth: 2
   :caption: Theory

   theory

.. toctree::
   :maxdepth: 2
   :caption: Examples

   examples

.. toctree::
   :maxdepth: 2
   :caption: User documentation

   docstrings