Migrated from GitHub

data/.readthedocs.yml

@@ -0,0 +1,26 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      - python -m pip install sphinx_rtd_theme
+
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: requirements.txt

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+## How to Contribute to FoundationDesign 🎉
+
+Thanks so much for considering contributing to **FoundationDesign**! Here's how you can get involved:
+
+- **🔧 Submit Pull Requests**  
+  Contributions that add features, improve tests, or fix bugs are highly welcome. Please ensure your code passes existing tests and adheres to the project's style (Ruff, SciPy/NumPy conventions).
+
+- **🧩 Pick a Good First Issue**  
+  If you're new, check out the open issues or the "Future Works" section in the README-for example, adding PDF report generation, strip/strap footing design, API support, or expanding foundation types (piles, rafts).
+
+- **💡 Share Feedback**  
+  This is my first major Python project-your thoughts on usability, documentation, test quality, even coding style are incredibly valuable. Constructive feedback helps the project grow!
+
+- **🐛 Report Bugs or Suggest Features**  
+  Spot a bug? Have a feature request? Just open an issue on GitHub-it’s the most straightforward way for me to track and respond. If it’s easier for you, feel free to message me at kunleyusuf858@outlook.com.
+
+---
+
+### 🛠 Getting Started
+
+1. **Fork** the repo and create a feature branch.  
+2. **Install locally** with `pip install -e .` and run `pytest`.  
+3. **Write tests** for any new functionality or bug fix.  
+4. **Open a Pull Request** with a clear description of your changes.
+
+---
+
+### 🤝 Need Help?
+
+Don't hesitate to contact me if you're unsure where to start or want to discuss your ideas. Happy to guide you through the process!
+
+---
+
+Your contribution-no matter how small-helps make `FoundationDesign` better for learners, practitioners, and engineers worldwide. Let's build something great together!  

data/FoundationDesign/__init__.py

@@ -0,0 +1,20 @@
+from FoundationDesign.foundationdesign import PadFoundation, padFoundationDesign
+from FoundationDesign.datavalidation import (
+    assert_input_limit,
+    assert_number,
+    assert_strictly_positive_number,
+    assert_maximum_input_limit,
+    assert_input_range,
+)
+from FoundationDesign.concretedesignfunc import (
+    bending_reinforcement,
+    minimum_steel,
+    maximum_steel,
+    shear_stress_check_1d,
+    column_punching_coefficient_k,
+    reinforcement_provision,
+)
+from FoundationDesign.combinedfootingdesign import (
+    CombinedFootingAnalysis,
+    CombinedFootingDesign,
+)

data/FoundationDesign/concretedesignfunc.py

@@ -0,0 +1,242 @@
+import math
+import numpy as np
+
+
+def shear_check_column_face(column_perimeter: float, fck: float, d: float):
+    """
+    Function to check the shear at column face. This would be used to ascertain
+    the suitability of the initial depth assumed.
+
+    Parameters
+    ----------
+    column_perimeter : float
+        The column perimeter in m
+    fck : float
+        Characteristic compressive cylinder strength in N/mm2. Accepted range of values [16,20,25,30,32,35,37,40,45,55]
+    fyk : float
+        Characteristic yield strength of reinforcement in N/mm2
+    d : float
+        Depth to tension reinforcement in mm
+
+    Returns
+    -------
+    float
+        Maximum shear resistance in N/mm2
+    """
+    Vrd_max = (0.5 * column_perimeter * d * (0.6 * (1 - fck / 250)) * fck / 1.5) / 1000
+    return Vrd_max
+
+
+def punching_shear_column_face(d: float, fck: float, column_perimeter: float):
+    """
+    Function to check the shear at column face.
+
+    Parameters
+    ----------
+    column_perimeter : float
+        The column perimeter in m
+    fck : float
+        Characteristic compressive cylinder strength in N/mm2. Accepted range of values [16,20,25,30,32,35,37,40,45,55]
+    d : float
+        Depth to tension reinforcement in mm
+    fck : float
+        Characteristic compressive cylinder strength in N/mm2. Accepted range of values [16,20,25,30,32,35,37,40,45,55]
+
+    Returns
+    -------
+    float
+        Maximum shear resistance in N/mm2
+    """
+    vrd_max = 0.2 * (1 - fck / 250) * fck * column_perimeter * d
+    return round(vrd_max, 3)
+
+
+def bending_reinforcement(
+    m: float, depth: float, fck: float, fyk: float, length: float
+):
+    """
+    Function to calculate the area of steel required according to eurocode 2.
+
+    Parameters
+    ----------
+    m : float
+        design bending moment in kNm
+    depth : float
+        Depth to tension reinforcement in m
+    fck : float
+        Characteristic compressive cylinder strength in N/mm2. Accepted range of values [16,20,25,30,32,35,37,40,45,55]
+    fyk : float
+        Characteristic yield strength of reinforcement in N/mm2
+    length : float
+        Length of the element to be designed in mm
+
+    Returns
+    -------
+    float
+        Area of steel required in mm2
+    """
+    compression_status = None
+    depth = depth * 1000
+    k = (m * 10**6) / (fck * length * (depth**2.0))
+    if k > 0.167:
+        compression_status = "Compression Reinforcement required, design out of scope"
+    la = 0.5 + math.sqrt(0.25 - (0.882 * k))
+    if la >= 0.95:
+        la = 0.95
+    area_of_steel = (m * 10**6) / (0.87 * fyk * la * depth)
+    return {
+        "area_of_steel": round(area_of_steel),
+        "compression_status": compression_status,
+    }
+
+
+def minimum_steel(fck: float, fyk: float, bt: float, d: float):
+    """
+    Function to calculate the minimum area of steel required.
+
+    Parameters
+    ----------
+    fck : float
+        Characteristic compressive cylinder strength in N/mm2. Accepted range of values [16,20,25,30,32,35,37,40,45,55]
+    fyk : float
+        Characteristic yield strength of reinforcement in N/mm2
+    bt : float
+        width in mm
+    d : float
+        Depth to tension reinforcement in m
+
+    Returns
+    -------
+    float
+        Minimum area of steel required in mm2
+    """
+    d = d * 1000
+    as_min = (0.078 * (fck ** (2 / 3)) / fyk) * bt * d
+    limiting_as = 0.0013 * bt * d
+    minimum_as = max(as_min, limiting_as)
+    return round(minimum_as, 0)
+
+
+def maximum_steel(length: float, d: float):
+    """
+    Function to calculate the maximum area of steel required.
+
+    Parameters
+    ----------
+    length : float
+        Length in m
+    d : float
+        Depth to tension reinforcement in m
+
+    Returns
+    -------
+    float
+        Maximum area of steel required in mm2
+    """
+    max_area = 0.04 * length * d
+    return max_area
+
+
+def shear_stress_check_1d(d: float, px: float, fck: float):
+    """
+    Function to determine the rectangular section in shear at a distance equivalent to 1d from the column face.
+
+    Parameters
+    ----------
+    d : float
+        Depth to tension reinforcement in m
+    px : float
+        Longitudinal reinforcement ratio unitless
+    fck : float
+        Characteristic compressive cylinder strength in N/mm2. Accepted range of values [16,20,25,30,32,35,37,40,45,55]
+
+    Returns
+    -------
+    float
+        resistance of members without shear reinforcement in MPa
+    """
+    k = min((1 + math.sqrt(200 / d)), 2)
+    p1 = min(px, 0.02)
+    vrd_c = max(
+        (0.12 * k * ((100 * p1 * fck) ** (1 / 3))), (0.035 * (k**1.5) * (fck**0.5))
+    )
+    return round(vrd_c, 3)
+
+
+def column_punching_coefficient_k(column_ratio: float):
+    """Interpolating Values of k for rectangular loaded areas from table 6.1 of the Eurocode 2."""
+    x = np.array([0.5, 1, 2, 3])
+    y = np.array([0.45, 0.6, 0.7, 0.8])
+    if column_ratio < np.min(x) or column_ratio > np.max(x):
+        raise ValueError("column_ratio is outside the valid range for interpolation")
+    # Linear interpolation using numpy.interp
+    k = np.interp(column_ratio, x, y)
+    return k
+
+
+def reinforcement_provision(assteel, fy):
+    """
+    Reinforcement area (mm2/m) for different bar spacing.
+
+    Parameters
+    ----------
+    assteel : float
+        Area of steel required calculated in mm2/m
+    fy : float
+        Characteristic yield strength of reinforcement in N/mm2
+
+    Returns
+    -------
+    t : string
+        Steel class label R for mild steel Grade 250, Y for Grade 410 (Type 2), T for Grade 460 (Type 2),
+         H for Grade 500 (Type 2).
+    rd : string
+        Rod diameters in mm range 8,10,12,16,20,25,32,40
+    sv : float
+        bar spacing in mm
+    asteel_provided : float
+        Area of steel provided in mm2/m
+    """
+    if fy <= 250:
+        t = "R"
+    elif fy > 250 and fy <= 410:
+        t = "Y"
+    elif fy > 410 and fy <= 460:
+        t = "T"
+    elif fy > 460 and fy <= 500:
+        t = "H"
+    if assteel <= 402:
+        rd = "8mm"
+        dia = 8.00
+    elif assteel > 402 and assteel <= 628:
+        rd = "10mm"
+        dia = 10.00
+    elif assteel > 628 and assteel <= 905:
+        rd = "12mm"
+        dia = 12.00
+    elif assteel > 905 and assteel <= 1610:
+        rd = "16mm"
+        dia = 16.00
+    elif assteel > 1610 and assteel <= 2510:
+        rd = "20mm"
+        dia = 20.00
+    elif assteel > 2510 and assteel <= 3930:
+        rd = "25mm"
+        dia = 25.00
+    elif assteel > 3930 and assteel <= 6430:
+        rd = "32mm"
+        dia = 32.00
+    elif assteel > 6430:
+        rd = "40mm"
+        dia = 40.00
+    area = (math.pi * dia**2) / 4
+    v1 = assteel / area
+    v = 1000 / v1
+    n = int(v / 25) * 25
+    if n > 200 and fy <= 250:
+        n = 200
+    elif n > 250 and fy > 250:
+        n = 250
+    sv = float(n)
+    asteel_provided = round(area * (1000 / sv))
+    return [t, rd, sv, asteel_provided]

data/FoundationDesign/datavalidation.py

@@ -0,0 +1,76 @@
+"""Module to aid with data validation of inputs"""
+
+
+def assert_positive_number(n, name):
+    """Assert that an input is a positive number."""
+    if type(n) not in [int, float]:
+        raise ValueError(
+            f"The value for '{name}' should be an integer or a float, not a {type(n)}."
+        )
+    if n < 0:
+        raise ValueError(f"The value for '{name}' should be >= 0, not {n}")
+
+
+def assert_strictly_positive_number(n, name):
+    """Assert that an input is a strictly positive number."""
+    if type(n) not in [int, float]:
+        raise ValueError(
+            f"The value for '{name}' should be an integer or a float, not a {type(n)}."
+        )
+    if n < 0:
+        raise ValueError(f"The value for '{name}' should be > 0, not {n}")
+
+
+def assert_number(n, name):
+    """Assert that an input is a number."""
+    if type(n) not in [int, float]:
+        raise ValueError(
+            f"The value for '{name}' should be an integer or a float, not a {type(n)}."
+        )
+
+
+def assert_length(l, num, name):
+    """Assert that a tuple or list is of a specific length."""
+    if len(l) != num:
+        raise ValueError(f"The length of '{name}' should be {num} not {len(l)}.")
+
+
+def assert_list_contents(l, content, name):
+    """Assert that a tuple or list contains only specific items"""
+    for a in l:
+        if a not in content:
+            raise ValueError(
+                f"The variable '{name}', must be a tuple or"
+                + f" list containing only items in {content} not {a}."
+            )
+
+
+def assert_contents(var, content, name):
+    """Assert that a variable is within a specific subset of available values"""
+
+    var = [var]
+    for a in var:
+        if a not in content:
+            raise ValueError(
+                f"The variable '{name}', must only have a"
+                + f" value that is specified in {content} not '{a}'."
+            )
+
+
+def assert_input_limit(l, num, name):
+    """Assert that a tuple or list is of a specific length."""
+    if l < num:
+        raise ValueError(f"The value of '{name}' should be greater than {num} not {l}.")
+
+
+def assert_maximum_input_limit(l, num, name):
+    """Assert that a tuple or list is of a specific length."""
+    if l > num:
+        raise ValueError(f"The value of '{name}' should be less than {num} not {l}.")
+
+
+def assert_input_range(name, value, range_of_values):
+    if value not in range_of_values:
+        raise ValueError(
+            f"The value for '{name}' should be in the range of {range_of_values} not {value}mm"
+        )

data/LICENSE

@@ -0,0 +1,674 @@
+GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

data/README.md

@@ -0,0 +1,162 @@
+# FoundationDesign
+
+[![PyPi](https://img.shields.io/pypi/v/FoundationDesign.svg)](https://pypi.org/project/FoundationDesign/)
+![PyPI - License](https://img.shields.io/pypi/l/FoundationDesign)
+[![Downloads](https://static.pepy.tech/badge/foundationdesign)](https://pepy.tech/project/foundationdesign)
+[![Downloads](https://static.pepy.tech/badge/foundationdesign/month)](https://pepy.tech/project/foundationdesign)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/FoundationDesign)
+[![build & test](https://github.com/kunle009/FoundationDesign/actions/workflows/build-and-test.yml/badge.svg?branch=main)](https://github.com/kunle009/FoundationDesign/actions/workflows/build-and-test.yml)
+[![Documentation Status](https://readthedocs.org/projects/foundationdesign/badge/?version=latest)](https://foundationdesign.readthedocs.io/en/latest/?badge=latest)
+[![Code style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/format.json)](https://github.com/charliermarsh/ruff)
+[![Webapp](https://img.shields.io/website?url=https%3A%2F%2Ffoundationcalcs.com)](https://foundationcalcs.com)
+
+🚀 **Exciting Update**: The [FoundationCalcs](https://foundationcalcs.com) website is now live for beta testing! The platform allows you design foundations and download comprehensive pdf report. You can access the pad foundation calculator [here](https://foundationcalcs.com/pad_foundation_calculator) and the combined pad foundation calculator [here](https://foundationcalcs.com/combined_pad_foundation_calculator) and start interacting with this library via a web UI. Your feedback is important to improve the core library and the web platform.
+
+---
+
+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 software's.
+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 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.
+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/en/latest/examples.html) includes [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) can be accessed at [FoundationCalcs](https://foundationcalcs.com).
+
+## Project Purpose
+
+1. Create a free python package that can analyse and design pad foundation,combined footing foundation,
+   pile foundation and raft foundation design.
+
+2. Create a comprehensive web app for the structural design of foundations.
+
+## Functionality and usage
+
+For now this package is limited to only concentric and eccentric pad foundation and combined footing foundation types.
+A typical use case of the pad foundation class contained in the `FoundationDesign` module includes
+
+- Create a `PadFoundation` object to help analyse
+- Assign `foundation_loads` to the `PadFoundation`
+- Assign `column_axial_loads` to the `PadFoundation`
+- Assign `column_horizontal_loads_xdir` to the `PadFoundation`
+- Assign `column_horizontal_loads_xdir` to the `PadFoundation`
+- Assign `column_moments_xdir` to the `PadFoundation`
+- Assign `column_moments_ydir` to the `PadFoundation`
+- Check the `minimum_area_required` for the `PadFoundation`
+- Check the `bearing_pressure_check_sls` on the `PadFoundation`
+- Create a `PadFoundationDesign` object to help design the foundation
+- Plot the Bending moment and shear force diagrams
+- Check the area of steel required and provided in x and y direction
+- Check the adequacy of the transverse shear along both column_axial_loads
+- Check for `punching_shear_column_face` on the `PadFoundationDesign` object
+- Check for `punching_shear_check_1d` on the `PadFoundationDesign` object
+- Check for `punching_shear_check_2d` on the `PadFoundationDesign` object
+
+## Creating a Pad Foundation
+
+The creation of a `PadFoundation` instance involves the input of the following:
+
+1.  Foundation Length in mm
+2.  Foundation Width in mm
+3.  Column Length in mm
+4.  Column Width in mm
+5.  The position of the column along x direction from the origin in mm
+6.  The position of the column along y direction from the origin in mm
+7.  The soil bearing capacity in kN/mm2
+
+        from foundationdesign import PadFoundation,padFoundationDesign
+        fdn = PadFoundation(foundation_length=2500,foundation_width=2500,column_length=400,column_width=400,col_pos_xdir=1250,col_pos_ydir=1250,soil_bearing_capacity=200)
+
+## Assigning Foundation Loads
+
+Soil self weight and concrete self weight can be added to the Foundation by specifying the Foundation thickness in
+mm and the soil depth above the Foundation in mm. A default value of 18kN/mm³ and 24kN/mm³ has been specified
+for soil unit weight and concrete unit weight respectively
+
+    fdn.foundation_loads(foundation_thickness=650,soil_depth_abv_foundation=0,soil_unit_weight=18,concrete_unit_weight=24)
+
+## Assigning Column Loads
+
+Axial loads, horizontal loads in x and y direction, moments in x and y direction
+can all be added to the pad foundation for permanent,imposed and wind load cases.
+
+    fdn.column_axial_loads(permanent_axial_load=800,imposed_axial_load=300)
+
+## Designing a pad foundation
+
+To design the foundation the `PadFoundation` must first be created as done above
+this would then be included when creating the `padFoundationDesign` object
+The creation of this object includes the following:
+
+1.  PadFoundation object created
+2.  Characteristic compressive cylinder strength in N/mm2. Accepted range of values [16,20,25,30,32,35,37,40,45,55]
+3.  Characteristic yield strength of reinforcement in N/mm2
+4.  Nominal cover to foundation in mm
+5.  Initial assumed bar diameter of the foundation in the x direction in mm. Accepted range of values [8,10,12,16,20,25,32,40]
+    used to calculate depth to tension reinforcement along the x direction
+6.  Initial assumed bar diameter of the foundation in the y direction in mm Accepted range of values [8,10,12,16,20,25,32,40]
+    used to calculate depth to tension reinforcement along the y direction
+
+        fdn_design = padFoundationDesign(fdn, fck=30, fyk=500, concrete_cover=40, bar_diameterX=16, bar_diameterY=16)
+
+## Plotting Foundation forces
+
+Lots of checks can be done on the Foundation which can be found in the notebooks contained in the examples folder
+To show the bending moment of the Foundation. The `plot_bending_moment_X()` can be called this figure will show the
+bending moment values at the critical location along the Foundation length or width. Plotting methods takes a show_plot argument which can either be True or False. which by default is True
+
+    fdn_design.plot_bending_moment_X()
+    fdn_design.plot_shear_force_X()
+
+This outputs the bending moment plot with the design bending moment shown at the face of the column
+![Image](https://github.com/kunle009/FoundationDesign/blob/main/assets/bending_moment1.png?raw=true)
+The shear force plot is also displayed with critical shearforce showing at 1d from column the face
+![Image](https://github.com/kunle009/FoundationDesign/blob/main/assets/shear_force.jpg?raw=true)
+
+## Installing the package
+
+If you want to install the `FoundationDesign` package, you run this one-liner:
+
+    pip install FoundationDesign
+
+**NOTE**: You need Python 3 to install this package (you may need to write `pip3` instead of `pip`).
+
+The library dependencies are listed in the file `requirements.txt`, but you only need to look at them if you clone the repository.
+If you install the package via `pip`, the listed dependencies should be installed automatically. You need a minimum of python version 3.8 to use this library.
+
+## Future Works
+
+The following are areas that will be implemented in future:
+
+- [ ] PDF report generation
+- [x] User documentation
+- [ ] A comprehensive web app for analysis and design of foundations
+- [ ] Strip Footing Design (Eurocode 2)
+- [ ] Strap Footing Design (Eurocode 2)
+- [ ] API Support
+
+## Contributing
+
+The guidelines for contributing are specified [here](https://github.com/kunle009/Foundationdesign/blob/main/CONTRIBUTING.md).
+
+## Support
+
+The guidelines for support are specified [here](https://github.com/kunle009/Foundationdesign/blob/main/SUPPORT.md).
+
+## License
+
+[![PyPI - License](https://img.shields.io/pypi/l/FoundationDesign)](https://github.com/kunle009/FoundationDesign/blob/main/LICENSE)
+
+Copyright (c) 2022, Kunle Yusuf

data/SUPPORT.md

@@ -0,0 +1,14 @@
+## Support for FoundationDesign 🛠️
+
+Thank you for using **FoundationDesign**! If you encounter any issues or have suggestions, we’re here to help:
+
+- **🐞 Found a bug?**  
+  Please open an issue on GitHub so I can track and address it. The issue tracker is the fastest way to get support.  
+
+- **✨ Feature requests welcome!**  
+  If you have an idea for a new feature, Let me know by opening an issue or drop me a message.
+
+- **📬 Prefer to reach out directly?**  
+  You can email me at **[kunleyusuf858@outlook.com]** for questions or feedback.
+
+I review all contributions, questions, and comments seriously. Your input helps make `FoundationDesign` better for everyone—students, engineers, and educators. Thank you for your support!  

data/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

data/docs/conf.py

@@ -0,0 +1,35 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../"))
+
+import sphinx_rtd_theme
+
+project = "FoundationDesign"
+copyright = "2024, Kunle Yusuf"
+author = "Kunle Yusuf"
+release = "0.1.2"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]

data/docs/docstrings.rst

@@ -0,0 +1,145 @@
+.. _docstrings:
+
+===========================
+FoundationDesign Reference
+===========================
+
+Pad Foundation Analysis
+-----------------------
+.. autoclass:: FoundationDesign.PadFoundation
+.. autofunction:: FoundationDesign.PadFoundation.__init__
+.. autofunction:: FoundationDesign.PadFoundation.area_of_foundation
+.. autofunction:: FoundationDesign.PadFoundation.plot_geometry
+.. autofunction:: FoundationDesign.PadFoundation.foundation_loads
+.. autofunction:: FoundationDesign.PadFoundation.column_axial_loads
+.. autofunction:: FoundationDesign.PadFoundation.column_horizontal_loads_xdir
+.. autofunction:: FoundationDesign.PadFoundation.column_horizontal_loads_ydir
+.. autofunction:: FoundationDesign.PadFoundation.column_moments_xdir
+.. autofunction:: FoundationDesign.PadFoundation.column_moments_ydir
+.. autofunction:: FoundationDesign.PadFoundation.total_force_X_dir_sls
+.. autofunction:: FoundationDesign.PadFoundation.total_force_Y_dir_sls
+.. autofunction:: FoundationDesign.PadFoundation.total_force_Z_dir_sls
+.. autofunction:: FoundationDesign.PadFoundation.total_moments_X_direction_sls
+.. autofunction:: FoundationDesign.PadFoundation.total_moments_Y_direction_sls
+.. autofunction:: FoundationDesign.PadFoundation.eccentricity_X_direction_sls
+.. autofunction:: FoundationDesign.PadFoundation.eccentricity_Y_direction_sls
+.. autofunction:: FoundationDesign.PadFoundation.pad_base_pressures_sls
+.. autofunction:: FoundationDesign.PadFoundation.bearing_pressure_check_sls
+.. autofunction:: FoundationDesign.PadFoundation.plot_base_pressures_sls
+.. autofunction:: FoundationDesign.PadFoundation.total_force_X_dir_uls
+.. autofunction:: FoundationDesign.PadFoundation.total_force_Y_dir_uls
+.. autofunction:: FoundationDesign.PadFoundation.total_force_Z_dir_uls
+.. autofunction:: FoundationDesign.PadFoundation.total_moments_X_direction_uls
+.. autofunction:: FoundationDesign.PadFoundation.total_moments_Y_direction_uls
+.. autofunction:: FoundationDesign.PadFoundation.eccentricity_X_direction_uls
+.. autofunction:: FoundationDesign.PadFoundation.eccentricity_Y_direction_uls
+.. autofunction:: FoundationDesign.PadFoundation.pad_base_pressures_uls
+.. autofunction:: FoundationDesign.PadFoundation.base_pressure_rate_of_change_X
+.. autofunction:: FoundationDesign.PadFoundation.base_pressure_rate_of_change_Y
+
+
+Pad Foundation Design
+---------------------
+.. autoclass:: FoundationDesign.padFoundationDesign
+.. autofunction:: FoundationDesign.padFoundationDesign.__init__
+.. autofunction:: FoundationDesign.padFoundationDesign.__loading_diagrams_X_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.__loading_diagrams_Y_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.plot_foundation_loading_X
+.. autofunction:: FoundationDesign.padFoundationDesign.plot_foundation_loading_Y
+.. autofunction:: FoundationDesign.padFoundationDesign.plot_bending_moment_X
+.. autofunction:: FoundationDesign.padFoundationDesign.plot_bending_moment_Y
+.. autofunction:: FoundationDesign.padFoundationDesign.plot_shear_force_X
+.. autofunction:: FoundationDesign.padFoundationDesign.plot_shear_force_Y
+.. autofunction:: FoundationDesign.padFoundationDesign.get_design_moment_X
+.. autofunction:: FoundationDesign.padFoundationDesign.get_design_moment_Y
+.. autofunction:: FoundationDesign.padFoundationDesign.get_design_shear_force_X
+.. autofunction:: FoundationDesign.padFoundationDesign.get_design_shear_force_Y
+.. autofunction:: FoundationDesign.padFoundationDesign.area_of_steel_reqd_X_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.__reinforcement_calculations_X_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.reinforcement_provision_flexure_X_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.area_of_steel_reqd_Y_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.__reinforcement_calculations_Y_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.reinforcement_provision_flexure_Y_dir
+.. autofunction:: FoundationDesign.padFoundationDesign.tranverse_shear_check_Xdir
+.. autofunction:: FoundationDesign.padFoundationDesign.tranverse_shear_check_Ydir
+.. autofunction:: FoundationDesign.padFoundationDesign.__punching_shear
+.. autofunction:: FoundationDesign.padFoundationDesign.update_punching_shear_stress_factor
+.. autofunction:: FoundationDesign.padFoundationDesign.punching_shear_column_face
+.. autofunction:: FoundationDesign.padFoundationDesign.punching_shear_check_1d
+.. autofunction:: FoundationDesign.padFoundationDesign.punching_shear_check_2d
+
+
+Combined Pad Foundation Analysis
+--------------------------------
+.. autoclass:: FoundationDesign.CombinedFootingAnalysis
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.__init__
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_1_geometry
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_2_geometry
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_1_axial_loads
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_1_horizontal_loads_xdir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_1_horizontal_loads_ydir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_1_moments_xdir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_1_moments_ydir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_2_axial_loads
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_2_horizontal_loads_xdir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_2_horizontal_loads_ydir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_2_moments_xdir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.update_column_2_moments_ydir
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.foundation_loads
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.area_of_foundation
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_X_dir_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Y_dir_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Z_dir_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Y_dir_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Z_dir_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_moments_X_direction_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_moments_Y_direction_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.eccentricity_X_direction_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.eccentricity_Y_direction_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.pad_base_pressures_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.bearing_pressure_check_sls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.minimum_area_required_wt_moment
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.minimum_area_required
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.foundation_geometry_optimizer
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.plot_optimized_geometry
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_X_dir_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Y_dir_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Z_dir_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Y_dir_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_force_Z_dir_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_moments_X_direction_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.total_moments_Y_direction_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.eccentricity_X_direction_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.eccentricity_Y_direction_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.pad_base_pressures_uls
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.base_pressure_rate_of_change_X
+.. autofunction:: FoundationDesign.CombinedFootingAnalysis.base_pressure_rate_of_change_Y
+
+Combined Pad Foundation Design
+------------------------------
+.. autoclass:: FoundationDesign.CombinedFootingDesign
+.. autofunction:: FoundationDesign.CombinedFootingDesign.__init__
+.. autofunction:: FoundationDesign.CombinedFootingDesign.__loading_diagrams_X_dir
+.. autofunction:: FoundationDesign.CombinedFootingDesign.__loading_diagrams_Y_dir
+.. autofunction:: FoundationDesign.CombinedFootingDesign.plot_foundation_loading_X
+.. autofunction:: FoundationDesign.CombinedFootingDesign.plot_foundation_loading_Y
+.. autofunction:: FoundationDesign.CombinedFootingDesign.plot_bending_moment_X
+.. autofunction:: FoundationDesign.CombinedFootingDesign.plot_bending_moment_Y
+.. autofunction:: FoundationDesign.CombinedFootingDesign.plot_shear_force_X
+.. autofunction:: FoundationDesign.CombinedFootingDesign.plot_shear_force_Y
+.. autofunction:: FoundationDesign.CombinedFootingDesign.get_design_moment_X
+.. autofunction:: FoundationDesign.CombinedFootingDesign.get_design_moment_Y
+.. autofunction:: FoundationDesign.CombinedFootingDesign.get_design_shear_force_X
+.. autofunction:: FoundationDesign.CombinedFootingDesign.get_design_shear_force_Y
+.. autofunction:: FoundationDesign.CombinedFootingDesign.area_of_steel_reqd_X_dir
+.. autofunction:: FoundationDesign.CombinedFootingDesign.area_of_steel_reqd_Y_dir
+.. autofunction:: FoundationDesign.CombinedFootingDesign.tranverse_shear_check_Xdir
+.. autofunction:: FoundationDesign.CombinedFootingDesign.tranverse_shear_check_Ydir
+.. autofunction:: FoundationDesign.CombinedFootingDesign.__punching_shear
+.. autofunction:: FoundationDesign.CombinedFootingDesign.update_punching_shear_stress_factor
+.. autofunction:: FoundationDesign.CombinedFootingDesign.col_1_punching_shear_column_face
+.. autofunction:: FoundationDesign.CombinedFootingDesign.col_1_punching_shear_check_1d
+.. autofunction:: FoundationDesign.CombinedFootingDesign.col_1_punching_shear_check_2d
+.. autofunction:: FoundationDesign.CombinedFootingDesign.col_2_punching_shear_column_face
+.. autofunction:: FoundationDesign.CombinedFootingDesign.col_2_punching_shear_check_1d
+.. autofunction:: FoundationDesign.CombinedFootingDesign.col_2_punching_shear_check_2d

data/docs/examples.rst

@@ -0,0 +1,26 @@
+.. _examples:
+
+1. Introduction to Examples
+==============================
+
+This section demonstrates the core functionality of the ``FoundationDesign` package with examples. Examples were taken from textbooks by Prab Bhatt and Mosley and Bungey.
+
+
+
+
+.. image:: https://colab.research.google.com/assets/colab-badge.svg
+   :target: https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Concentric_Footing_Example.ipynb
+
+.. image:: https://colab.research.google.com/assets/colab-badge.svg
+   :target: https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Eccentric_Footing_Example.ipynb
+
+.. image:: https://colab.research.google.com/assets/colab-badge.svg
+   :target: https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Combined_Footing_Mosley_bungey.ipynb
+
+
+In order to effectively use the package online you should first run the cell that initialises the notebook by installing the package.
+
+You can also approach the problems using the web-based graphical user interface |website|
+
+.. image:: https://img.shields.io/website?url=https%3A%2F%2Fwww.foundationcalcs.com%2F
+   :alt: Website

data/docs/index.rst

@@ -0,0 +1,59 @@
+.. 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

data/docs/installation.rst

@@ -0,0 +1,23 @@
+.. _installation:
+
+===========
+First steps
+===========
+
+* The easiest way to try this package for now is using a web-based notebook:
+* Here's an example featuring the design of a concentric pad foundation
+
+.. image:: https://colab.research.google.com/assets/colab-badge.svg
+   :target: https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Concentric_Footing_Example.ipynb
+
+* You can also download and install the ``FoundationDesign`` package, which runs on Python 3.
+
+  * If you do not have a Python 3 interpreter on your machine, you can install the last version following the instructions in `this tutorial <https://realpython.com/installing-python/>`_.
+  * Once you have Python 3, you can open a terminal and install the package with this one-liner::
+
+      python3 -m pip install --user FoundationDesign
+
+    **NOTE**: You may need to replace ``python3`` above by the path to your Python 3 executable, or simply ``python`` if you are running Windows.
+
+This project is open source, and the code can be found in this `GitHub repository
+<https://github.com/kunle009/FoundationDesign/>`_.

data/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

data/docs/requirements_docs.txt

@@ -0,0 +1,3 @@
+sphinx
+sphinx-autobuild
+sphinx-rtd-theme

data/paper/paper.bib

@@ -0,0 +1,97 @@
+% Encoding: UTF-8
+@proceedings{en1992,
+  added-at = {2012-02-01T19:15:41.000+0100},
+  address = {Brussels},
+  author = {for Standardization, European Committee},
+  biburl = {https://www.bibsonomy.org/bibtex/2865a69d4ed9b68e3d4f05f1017574379/fusenbach},
+  interhash = {b2e52194701c070daec06ada4b82cb2e},
+  intrahash = {865a69d4ed9b68e3d4f05f1017574379},
+  keywords = {en1992},
+  organization = {EN},
+  owner = {Lars Thomsen},
+  publisher = {CEN},
+  timestamp = {2012-02-01T19:15:41.000+0100},
+  title = {EN 1992-1-1 Eurocode 2: Design of concrete structures - Part 1-1:  General ruels and rules for buildings},
+  year = 2005
+}
+
+@book{HibbelerRussell2013MoM,
+publisher = {P.Ed Australia},
+isbn = {9810694369},
+year = {2013},
+title = {Mechanics of Materials},
+language = {eng},
+address = {Melbourne},
+author = {Hibbeler, Russell},
+keywords = {Structural analysis (Engineering) ; Strength of materials},
+}
+
+@book{mosley1982reinforced,
+  title={Reinforced Concrete Design},
+  author={Mosley, W.H. and Bungey, J.H.},
+  isbn={9780333335567},
+  url={https://books.google.com.ng/books?id=PkBZAAAAYAAJ},
+  year={1982},
+  publisher={Macmillan}
+}
+
+@book{bhatt2014reinforced,
+  title={Reinforced Concrete Design to Eurocodes: Design Theory and Examples, Fourth Edition},
+  author={Bhatt, P. and MacGinley, T.J. and Choo, B.S.},
+  isbn={9781466552524},
+  lccn={2013028845},
+  url={https://books.google.com.ng/books?id=LWHvAgAAQBAJ},
+  year={2014},
+  publisher={Taylor \& Francis}
+}
+
+@book{arya2009design,
+  title={Design of Structural Elements: Concrete, Steelwork, Masonry and Timber Designs to British Standards and Eurocodes, Third Edition},
+  author={Arya, C.},
+  isbn={9781482288629},
+  url={https://books.google.com.ng/books?id=82BECgAAQBAJ},
+  year={2009},
+  publisher={CRC Press}
+}
+
+@article{Bonanno2021, 
+  doi = {10.21105/jose.00111}, 
+  url = {https://doi.org/10.21105/jose.00111}, 
+  year = {2021}, publisher = {The Open Journal},
+  volume = {4}, number = {40}, pages = {111}, 
+  author = {Jesse Bonanno}, title = {IndeterminateBeam: A Python package for solving 1D indeterminate beams}, 
+  journal = {Journal of Open Source Education} 
+}
+
+@Article{harris2020array,
+ title         = {Array programming with {NumPy}},
+ author        = {Charles R. Harris and K. Jarrod Millman and St{\'{e}}fan J.
+                 van der Walt and Ralf Gommers and Pauli Virtanen and David
+                 Cournapeau and Eric Wieser and Julian Taylor and Sebastian
+                 Berg and Nathaniel J. Smith and Robert Kern and Matti Picus
+                 and Stephan Hoyer and Marten H. van Kerkwijk and Matthew
+                 Brett and Allan Haldane and Jaime Fern{\'{a}}ndez del
+                 R{\'{i}}o and Mark Wiebe and Pearu Peterson and Pierre
+                 G{\'{e}}rard-Marchant and Kevin Sheppard and Tyler Reddy and
+                 Warren Weckesser and Hameer Abbasi and Christoph Gohlke and
+                 Travis E. Oliphant},
+ year          = {2020},
+ month         = sep,
+ journal       = {Nature},
+ volume        = {585},
+ number        = {7825},
+ pages         = {357--362},
+ doi           = {10.1038/s41586-020-2649-2},
+ publisher     = {Springer Science and Business Media {LLC}},
+ url           = {https://doi.org/10.1038/s41586-020-2649-2}
+}
+
+@online{plotly, 
+  author = {Plotly Technologies Inc.}, 
+  title = {Collaborative data science}, 
+  publisher = {Plotly Technologies Inc.}, 
+  address = {Montreal, QC}, year = {2015}, 
+  url = {https://plot.ly}
+}
+
+@Comment{jabref-meta: databaseType:bibtex;}

data/paper/paper.md

@@ -0,0 +1,168 @@
+---
+title: "FoundationDesign: A Python library for structural analysis and design of different foundation type in accordance to the Eurocodes and the UK National Annex"
+tags:
+  - foundation design
+  - foundation analysis
+  - foundation engineering
+  - eurocode
+  - structural engineering
+  - civil engineering
+  - Python
+authors:
+  - name: Kunle Yusuf
+    orcid: 0009-0009-2339-267X
+    affiliation: 1
+affiliations:
+  - name: No affiliation
+    index: 1
+date: 08 July 2025
+bibliography: paper.bib
+nocite: |
+  @Bonanno2021, @harris2020array
+---
+
+# Summary
+
+`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 software's. 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 project is based mainly on instructions contained in the [@en1992] and common engineering textbooks such as [@arya2009design], [@bhatt2014reinforced] and [@mosley1982reinforced]
+
+The package can be used by:
+
+- structural engineers to design foundations
+- civil engineering students to learn the manual design of foundations
+
+The [FoundationDesign repository](https://github.com/kunle009/) can be found on Github and is ready for installation using `pip`. Text-based examples of the package presented in the [documentation](http://foundationdesign.readthedocs.io/en/latest/examples.html) includes [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 available at [FoundationCalcs](https://foundationcalcs.com).
+
+# Statement of Need
+
+The structural design of foundations is a critical step in any civil infrastructure project, and proficiency in this area is essential for civil and structural engineers. However, there's a notable lack of tools that simplify and automate this process, especially via the web, which could significantly enhance accessibility to effective foundation design. The Python ecosystem for civil and structural engineers is also rapidly maturing. The `FoundationDesign` Python library contributes to this growth by complementing existing analysis and design libraries, all while remaining open source for further customization.
+
+**FoundationDesign** is a Python package that addresses these gaps by offering:
+
+1. **Comprehensive Theoretical Implementation**  
+   The package features a clear implementation of Eurocode 2 and UK National Annex principles and guidelines regarding bending, shear, punching shear, and sliding checks.
+
+2. **Interactive Computational Feedback**  
+   Users can define foundation geometry and loads -including axial, horizontal, and moment loads—and immediately generate bending moment and shear force diagrams, base pressure and minimum-area checks, punching shear assessments, sliding stability, and reinforcement sizing. This instant visual feedback reinforces understanding through experimentation.
+
+3. **Open-Source and Extensible**  
+   In stark contrast to prevailing practices in civil engineering software development -where applications are often closed-source and operate as 'black boxes'- `FoundationDesign` represents a significant departure. By fully embracing open source and currently licensed under GPL-3.0, it encourages both academic and professional users and engineers to inspect, adapt, and extend the library. Currently, `FoundationDesign` supports the design of concentric and eccentric pad foundations, as well as combined pad foundations.
+
+4. **Cloud Based Web GUI**  
+   A companion web app [FoundationCalcs](https://foundationcalcs.com) -currently in beta- offers a GUI for the use of non programmers making the library further accessible to a wide range of users.
+
+My structural design internship during my undergraduate studies served as the primary inspiration for this package. I spent that time designing foundations with an old Fortran command-line software that, while remarkably fast and efficient, demanded manual input through a cumbersome text file and lacked any visual feedback. This experience, alongside my growing interest in computer science since high school, propelled me to develop a more user-friendly and interactive software capable of designing foundations in a similar, powerful manner to the Fortran tool, but with a modern approach.
+
+## Functionality and Usage
+
+For now this package is limited to only concentric and eccentric pad foundation and combined footing foundation types.
+A typical use case of the pad foundation class contained in the `FoundationDesign` module includes
+
+- Create a `PadFoundation` object to help analyse
+- Assign `Loads` to the `PadFoundation` object
+- Solving for foundation forces
+- Design the foundation using the `padFoundationDesign` class
+- Check the design results
+- Plot foundation design forces.
+
+You can follow along with the example below, which is an excerpt from [@bhatt2014reinforced] section 11.4.2.1 page 443, in this web-based [Concentric Pad Foundation Notebook](https://colab.research.google.com/github/kunle009/FoundationDesign/blob/main/examples/Concentric_Footing_Example.ipynb).
+
+The units used throughout the Python package are SI units (newtons and metres)
+
+### Creating a Pad Foundation
+
+The creation of a `PadFoundation` instance involves the input of the foundation length and breadth (m), the column length and breadth (m), soil bearing capacity (kN/m2) and the column position in the x and y direction relative to the foundation's origin (m). The `PadFoundation` class is contained in the `FoundationDesign` module and can be imported as follows:
+
+```Python
+from FoundationDesign import PadFoundation,padFoundationDesign
+# Create a foundation with an initial size of 2.5m by 2.5m, 
+# supporting a 400mm x 400mm column carrying a dead load of 800kN and imposed load of 300kN
+# The soil bearing capacity is 200kN/m2.
+fdn = PadFoundation(
+    foundation_length=2500,
+    foundation_width=2500,
+    column_length=400,
+    column_width=400,
+    col_pos_xdir=1250,
+    col_pos_ydir=1250,
+    soil_bearing_capacity=200,
+)
+```
+
+### Defining Loads
+
+`FoundationDesign` supports different types of loading scenarios in both x and y direction. This includes `column_axial_loads`, `column_horizontal_loads_xdir`, `column_horizontal_loads_xdir`, `column_moments_xdir` and `column_moments_ydir`.
+These loads can be defined under three load cases `permanent` ,`imposed`and`wind`. With their accurate sign convention contained in the [documentation](https://foundationdesign.readthedocs.io/en/latest/docstrings.html)
+
+```Python
+# Define the column axial loads with dead load of 800kN and imposed load of 300kN
+fdn.column_axial_loads(permanent_axial_load=800,imposed_axial_load=300)
+```
+
+### Solving for Foundation Forces
+
+Once the `PadFoundation` object has been assigned with `Loads` objects it can then be solved. The foundation's pressure relative to the soil bearing capacity and the minimum area of the foundation can be accessed
+
+```Python
+fdn.bearing_pressure_check_sls()['status']
+area = fdn.minimum_area_required()
+```
+
+### Designing the Pad Foundation
+
+Designing the foundation involves creating a `padFoundationDesign` object, which takes the `PadFoundation` object as an argument alongside the concrete's `Fck`, `Fy`, `concrete_cover` and the reinforcement diameter in x and y directions `bar_diameterX` and `bar_diameterY`. The design allows the user check for bending moments, shear forces, punching shear, and reinforcement requirements in both directions. A proper description of symbols and units can be found in the [documentation](https://foundationdesign.readthedocs.io/en/latest/docstrings.html).
+
+```Python
+# Design the pad foundation with a grade 30 concrete strength, reinforcement strength of 500 N/mm2, 40mm concrete cover
+# and bar diameter of 16mm in both directions
+fdn_design = padFoundationDesign(
+    fdn, fck=30, fyk=500, concrete_cover=40, bar_diameterX=16, bar_diameterY=16
+)
+```
+
+### Checking Design Results
+
+Different results can be checked from the `padFoundationDesign` object, including the reinforcement area required and provided in both x and y directions, the transverse shear check, punching shear checks and sliding resistance check. For Example,
+
+```Python
+#Show the reinforcement area required along the x axis
+fdn_design.area_of_steel_reqd_X_dir()['area_required_per_m']
+# Show the transverse shear check along the x axis
+fdn_design.transverse_shear_check_X_dir()['status']
+# Show the punching shear check along the column face
+fdn_design.punching_shear_column_face()['status']
+# Show the punching shear check along the 1D perimeter
+fdn_design.punching_shear_check_1d()['status']
+# Show the punching shear check along the 2D perimeter
+fdn_design.punching_shear_check_2d()['status']
+# show the resistance of the foundation to sliding
+fdn_design.sliding_resistance_check()['status']
+```
+
+### Plotting results
+
+Lot's of results can be investigated by plotting different results from the `PadFoundation` and `padFoundationDesign` objects. The plots are generated using the [@plotly] library. Various other plots can be generated to visualise the foundation geometry, base pressures, loading diagrams, bending moment diagrams, and shear force diagrams. The following code snippet demonstrates how to generate some of these plots:
+
+```Python
+# Plot the bending moment diagram in x direction
+fdn_design.plot_bending_moment_X()
+# Plot the shear force diagram in x direction
+fdn_design.plot_shear_force_X()
+```
+
+This outputs the bending moment plot with the design bending moment shown at the face of the column.
+![Foundation Bending Moment in X direction](https://github.com/kunle009/FoundationDesign/blob/main/assets/bending_moment1.png?raw=true)
+The shear force plot is also displayed with critical shear force showing at 1d from column the face.
+![Foundation Shear Force in X direction](https://github.com/kunle009/FoundationDesign/blob/main/assets/shear_force.png?raw=true)
+
+# References

data/requirements-test.txt

@@ -0,0 +1,4 @@
+indeterminatebeam==2.2.1
+numpy==1.24.4
+plotly==5.15.0
+pytest

data/requirements.txt

@@ -0,0 +1,3 @@
+indeterminatebeam==2.2.1
+numpy>=1.24.4
+plotly>=5.15.0

data/setup.py

@@ -0,0 +1,31 @@
+from setuptools import setup
+
+# store readme.md files
+with open("README.md", "r") as fh:
+    long_description = fh.read()
+# read the requirements
+with open("requirements.txt", "r") as fh:
+    requirements = [line.strip() for line in fh]
+
+setup(
+    name="FoundationDesign",
+    packages=["FoundationDesign"],
+    version="0.1.2",
+    author="Kunle Yusuf",
+    author_email="kunleyusuf858@gmail.com",
+    description="A python module for structural analysis and design of different foundation types in accordance to the Eurocodes",
+    url="https://github.com/kunle009/FoundationDesign",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    classifiers=[
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.8",
+    install_requires=requirements,
+)

data/tests/CombinedFootingAnalysis.py

@@ -0,0 +1,31 @@
+import unittest
+from FoundationDesign.combinedfootingdesign import CombinedFootingAnalysis
+
+class CombinedFootingAnalysisTestCase:
+    def setUp(self):
+        comb_footing = CombinedFootingAnalysis(
+        foundation_length=4600,
+        foundation_width=2300,
+        soil_bearing_capacity=300,
+        spacing_btwn_columns=3000,
+    )
+        comb_footing.update_column_1_geometry(
+        column_length=300, column_width=300, col_pos_xdir=540, col_pos_ydir=1145
+        )
+        comb_footing.update_column_2_geometry(
+            column_length=400, column_width=400, col_pos_xdir=3540, col_pos_ydir=1145
+        )
+        comb_footing.update_column_1_axial_loads(
+            permanent_axial_load=1000, imposed_axial_load=200
+        )
+        comb_footing.update_column_2_axial_loads(
+            permanent_axial_load=1400, imposed_axial_load=300
+        )
+        comb_footing.foundation_loads(
+            foundation_thickness=850,
+            soil_depth_abv_foundation=0,
+            soil_unit_weight=18,
+            concrete_unit_weight=24,
+            consider_self_weight=False,
+        )
+        self.combined_footing = comb_footing

data/tests/test.py

@@ -0,0 +1,68 @@
+from FoundationDesign.foundationdesign import padFoundationDesign, PadFoundation
+
+fdn = PadFoundation(
+    foundation_length=3600,
+    foundation_width=3000,
+    column_length=450,
+    column_width=450,
+    col_pos_xdir=1800,
+    col_pos_ydir=1500,
+    soil_bearing_capacity=150,
+)
+
+z = fdn.foundation_loads(
+    foundation_thickness=550,
+    soil_depth_abv_foundation=0,
+    soil_unit_weight=18,
+    concrete_unit_weight=24,
+)
+fdn.column_axial_loads(permanent_axial_load=770, imposed_axial_load=330)
+fdn.column_horizontal_loads_xdir(
+    permanent_horizontal_load_xdir=35, imposed_horizontal_load_xdir=15
+)
+fdn.column_moments_xdir(permanent_moment_xdir=78, imposed_moment_xdir=34)
+
+
+fdn_design = padFoundationDesign(
+    fdn, fck=30, fyk=500, concrete_cover=30, bar_diameterX=16, bar_diameterY=16
+)
+
+# fdn_design.plot_foundation_loading_X()
+# fdn_design.plot_foundation_loading_Y()
+# fdn_design.plot_bending_moment_X()
+# fdn_design.plot_bending_moment_Y()
+# fdn_design.plot_shear_force_Y()
+# print(fdn_design.get_design_moment_X())
+# print(fdn_design.get_design_moment_Y())
+# print(fdn_design.get_design_shear_force_X())
+# print(fdn_design.area_of_steel_reqd_X_dir())
+# print(fdn_design.area_of_steel_reqd_Y_dir())
+print(fdn_design.reinforcement_provision_flexure_X_dir())
+print(fdn_design.reinforcement_provision_flexure_Y_dir())
+
+#print(fdn_design.punching_shear_column_face())
+#print(fdn_design.punching_shear_check_1d())
+#print(fdn_design.punching_shear_check_2d())
+#print(fdn_design.tranverse_shear_check_Xdir())
+#print(fdn_design.tranverse_shear_check_Ydir())
+#print(fdn_design.sliding_resistance_check())
+
+
+# outputs
+# print(fdn.area_of_foundation())
+# print(fdn.total_force_X_dir_sls())
+# print(fdn.total_force_Y_dir_sls())
+# print(fdn.total_force_Z_dir_sls())
+# print(fdn.total_moments_X_direction_sls())
+# print(fdn.total_moments_Y_direction_sls())
+# print(fdn.eccentricity_X_direction_sls())
+# print(fdn.eccentricity_Y_direction_sls())
+# print(fdn.pad_base_pressures_sls())
+# print(fdn.pad_base_pressures_uls())
+# print(fdn.total_force_X_dir_uls())
+# print(fdn.total_force_Y_dir_uls())
+# print(fdn.total_force_Z_dir_uls())
+# print(fdn.total_moments_X_direction_uls())
+# print(fdn.total_moments_Y_direction_uls())
+# print(fdn.eccentricity_X_direction_uls())
+# print(fdn.eccentricity_Y_direction_uls())

data/tests/test2.py

@@ -0,0 +1,36 @@
+from FoundationDesign import CombinedFootingAnalysis
+
+comb_footing = CombinedFootingAnalysis(
+    foundation_length=4600,
+    foundation_width=2300,
+    soil_bearing_capacity=300,
+    spacing_btwn_columns=3000,
+)
+comb_footing.update_column_1_geometry(
+    column_length=300, column_width=300, col_pos_xdir=540, col_pos_ydir=1145
+)
+comb_footing.update_column_2_geometry(
+    column_length=400, column_width=400, col_pos_xdir=3540, col_pos_ydir=1145
+)
+comb_footing.update_column_1_axial_loads(
+    permanent_axial_load=1000, imposed_axial_load=200
+)
+comb_footing.update_column_2_axial_loads(
+    permanent_axial_load=1400, imposed_axial_load=300
+)
+comb_footing.foundation_loads(
+    foundation_thickness=850,
+    soil_depth_abv_foundation=0,
+    soil_unit_weight=18,
+    concrete_unit_weight=24,
+    consider_self_weight=False,
+)
+# min_area = comb_footing.minimum_area_required()
+# z = comb_footing.foundation_geometry_optimizer()
+comb_footing.plot_geometry()
+pres = comb_footing.pad_base_pressures_sls()
+print(pres)
+pres = comb_footing.pad_base_pressures_uls()
+print(pres)
+comb_footing.bearing_pressure_check_sls()
+comb_footing.total_axial_force_uls()

data/tests/test_PadFoundation.py

@@ -0,0 +1,78 @@
+import unittest
+from FoundationDesign import PadFoundation
+
+
+class PadFoundationTestCase(unittest.TestCase):
+    def setUp(self):
+        fdn = PadFoundation(
+            foundation_length=3600,
+            foundation_width=3000,
+            column_length=450,
+            column_width=450,
+            col_pos_xdir=1800,
+            col_pos_ydir=1500,
+            soil_bearing_capacity=150,
+        )
+
+        z = fdn.foundation_loads(
+            foundation_thickness=550,
+            soil_depth_abv_foundation=0,
+            soil_unit_weight=18,
+            concrete_unit_weight=24,
+        )
+
+        fdn.column_axial_loads(permanent_axial_load=770, imposed_axial_load=330)
+        fdn.column_horizontal_loads_xdir(
+            permanent_horizontal_load_xdir=35, imposed_horizontal_load_xdir=15
+        )
+        fdn.column_moments_xdir(permanent_moment_xdir=78, imposed_moment_xdir=34)
+        self.pad_foundation = fdn
+
+    def test_foundation_loads(self):
+        pad_foundation = self.pad_foundation
+        self.assertEqual(
+            pad_foundation.foundation_loads(
+                foundation_thickness=550,
+                soil_depth_abv_foundation=0,
+                soil_unit_weight=18,
+                concrete_unit_weight=24,
+            ),
+            [13.2, 0.0],
+        )
+
+    def test_minimum_area_of_foundation(self):
+        pad_foundation = self.pad_foundation
+        self.assertEqual(pad_foundation.minimum_area_required(), 10.24)
+
+    def test_total_loads_moments(self):
+        pad_foundation = self.pad_foundation
+        self.assertEqual(pad_foundation.total_force_X_dir_sls(), 50)
+        self.assertEqual(pad_foundation.total_force_Y_dir_sls(), 0)
+        self.assertEqual(pad_foundation.total_force_Z_dir_sls(), 1242.56)
+        self.assertEqual(pad_foundation.total_force_X_dir_uls(), 69.75)
+        self.assertEqual(pad_foundation.total_force_Y_dir_uls(), 0)
+        self.assertEqual(pad_foundation.total_moments_X_direction_sls(), 2376.108)
+        self.assertEqual(pad_foundation.total_moments_Y_direction_sls(), 1863.84)
+        self.assertEqual(pad_foundation.total_moments_X_direction_uls(), 3303.183)
+        self.assertEqual(pad_foundation.total_moments_Y_direction_uls(), 2590.434)
+
+    def test_eccentricities(self):
+        pad_foundation = self.pad_foundation
+        self.assertEqual(pad_foundation.eccentricity_X_direction_uls(), 112.72)
+        self.assertEqual(pad_foundation.eccentricity_Y_direction_uls(), 0)
+        self.assertEqual(pad_foundation.eccentricity_X_direction_sls(), 112)
+        self.assertEqual(pad_foundation.eccentricity_Y_direction_sls(), 0)
+
+    def test_pad_base_pressure(self):
+        pad_foundation = self.pad_foundation
+        self.assertTupleEqual(
+            pad_foundation.pad_base_pressures_sls(), (93.576, 93.576, 136.528, 136.528)
+        )
+        self.assertTupleEqual(
+            pad_foundation.pad_base_pressures_uls(),
+            (129.863, 129.863, 189.944, 189.944),
+        )
+
+
+if __name__ == "__main__":
+    unittest.main(verbosity=2)

data/tests/test_PadFoundationDesign.py

@@ -0,0 +1,126 @@
+import unittest
+from FoundationDesign import padFoundationDesign, PadFoundation
+
+
+class PadFoundationDesignTestCase(unittest.TestCase):
+    def setUp(self):
+        fdn = PadFoundation(
+            foundation_length=3600,
+            foundation_width=3000,
+            column_length=450,
+            column_width=450,
+            col_pos_xdir=1800,
+            col_pos_ydir=1500,
+            soil_bearing_capacity=150,
+        )
+        z = fdn.foundation_loads(
+            foundation_thickness=550,
+            soil_depth_abv_foundation=0,
+            soil_unit_weight=18,
+            concrete_unit_weight=24,
+        )
+
+        fdn.column_axial_loads(permanent_axial_load=770, imposed_axial_load=330)
+        fdn.column_horizontal_loads_xdir(
+            permanent_horizontal_load_xdir=35, imposed_horizontal_load_xdir=15
+        )
+        fdn.column_moments_xdir(permanent_moment_xdir=78, imposed_moment_xdir=34)
+        fdn_design = padFoundationDesign(
+            fdn, fck=30, fyk=500, concrete_cover=30, bar_diameterX=16, bar_diameterY=16
+        )
+        self.pad_foundation_design = fdn_design
+
+    def test_foundation_plots(self):
+        pad_foundation_design = self.pad_foundation_design
+        # check plotting valid
+        # pad_foundation_design.plot_foundation_loading_X()
+        # pad_foundation_design.plot_foundation_loading_Y()
+        # pad_foundation_design.plot_bending_moment_X()
+        # pad_foundation_design.plot_bending_moment_Y()
+        # pad_foundation_design.plot_shear_force_Y()
+        self.assertEqual(pad_foundation_design.get_design_moment_X(), 607.861)
+        self.assertEqual(pad_foundation_design.get_design_moment_Y(), 415.754)
+        self.assertEqual(pad_foundation_design.get_design_shear_force_X(), 520.616)
+        self.assertEqual(pad_foundation_design.get_design_shear_force_Y(), 398.459)
+
+    def test_reinforcement_calculations(self):
+        pad_foundation_design = self.pad_foundation_design
+        self.assertEqual(pad_foundation_design.area_of_steel_reqd_X_dir()['area_required_per_m'], 958)
+        self.assertEqual(pad_foundation_design.area_of_steel_reqd_Y_dir()['area_required_per_m'], 747)
+        self.assertDictEqual(
+            pad_foundation_design.reinforcement_provision_flexure_X_dir(),
+            {
+                "steel_label": "H",
+                "bar_diameter": "16mm",
+                "bar_spacing": 200.0,
+                "area_provided": 1005,
+                "status": "Provide H16mm bars spaced at 200.0mm c/c bottom. The area provided is 1005mm²/m parallel to the 3.6m side",
+            },
+        )
+        self.assertDictEqual(
+            pad_foundation_design.reinforcement_provision_flexure_Y_dir(),
+            {
+                "steel_label": "H",
+                "bar_diameter": "12mm",
+                "bar_spacing": 150.0,
+                "area_provided": 754,
+                "status": "Provide H12mm bars spaced at 150.0mm c/c bottom. The area provided is 754mm²/m parallel to the 3.6m side",
+            },
+        )
+
+    def test_punching_shear(self):
+        pad_foundation_design = self.pad_foundation_design
+        self.assertDictEqual(
+            pad_foundation_design.punching_shear_column_face(),
+            {
+                "design_punching_shear_stress": 1.691468253968254,
+                "maximum_punching_shear_resistance": 4.488,
+                "status": "The maximum punching shear resistance of 4.488N/mm² exceeds the design punching shear stress of 1.691N/mm² - PASS!!!",
+            },
+        )
+        self.assertDictEqual(
+            pad_foundation_design.punching_shear_check_1d(),
+            {
+                "punching_shear_stress": 0.798,
+                "ved_design": 0.5876415001228639,
+                "status": "The maximum punching shear resistance of 0.798N/mm² exceeds the design punching shear stress of 0.588N/mm² - PASS!!!",
+            },
+        )
+        self.assertDictEqual(
+            pad_foundation_design.punching_shear_check_2d(),
+            {
+                "design_punching_shear_stress": 0.22247511396970102,
+                "shear_resistance_max": 0.399,
+                "status": "The maximum punching shear resistance of 0.399N/mm² exceeds the design punching shear stress of 0.222N/mm² - PASS!!!",
+            },
+        )
+
+    def test_sliding_transverse_checks(self):
+        pad_foundation_design = self.pad_foundation_design
+        self.assertDictEqual(
+            pad_foundation_design.tranverse_shear_check_Xdir(),
+            {
+                "design_shear_resistance": 609.792,
+                "status": "The design shear resistance of 609.792kN exceeds the design shear force of 520.616kN - PASS!!!",
+            },
+        )
+        self.assertDictEqual(
+            pad_foundation_design.tranverse_shear_check_Ydir(),
+            {
+                "design_shear_resistance": 739.123,
+                "status": "The design shear resistance of 739.123kN exceeds the design shear force of 398.459kN - PASS!!!",
+            },
+        )
+        self.assertDictEqual(
+            pad_foundation_design.sliding_resistance_check(),
+            {
+                "design_friction_angle": 0.349,
+                "sliding_resistance": 332.077,
+                "foundation_horizontal_force": 69.75,
+                "status": " The allowable sliding resistance 332kN is greater than the actual horizontal loads 70kN Status - PASS!!!",
+            },
+        )
+
+
+if __name__ == "__main__":
+    unittest.main(verbosity=2)

data/top_level.txt

@@ -0,0 +1,3 @@
+FoundationDesign/ Top-level package
+          __init__.py Initialization file for the package
+          foundationdesign.py Main code file