Welcome to OpenPile’s documentation!
This package is an open source python library that provides a toolbox for beam/pile calculations. It provides users with various objects to represent structural and geotechnical problems (such as piles, soil profiles, soil layers), and an assortment of routines for fast operations, including solving 1D FE beam models with or without Winkler approach.
Few features at a glance:
Finite Element calculations with 1D Beam elements (following Euler-Bernoulli or Timishenko beam theories) to compute forces, deformations
Winkler’s approach of a beam supported by linear or non-linear springs
Soil springs over axial, lateral and rotational degrees of freedoms
Common soil spring formulations to model soil structure interaction with the structure (a beam or pile)
More details on how to use the library can be found in Usage
Important
This library supports the following versions of python: 3.8-3.10. Python 3.11+ is not supported as one dependency of OpenPile (namely Numba) does not currently support Python 3.11+.
Cite OpenPile in your research paper
You can refer to OpenPile in your research paper by citing the following:
Guillaume M. (2023). TchilDill/openpile: OpenPile version 0.7.0 (v0.7.0). Zenodo. https://doi.org/10.5281/zenodo.10116667
Contents:
- Getting started
- Usage
- Example 1 - Create a pile
- Example 2 - Calculate and plot a p-y curve
- Example 3 - Create a soil profile’s layer
- Example 4 - Create a soil profile
- Example 5 - Run a lateral pile analysis
- Example 6 - Visualize a model
- Example 7 - Run a simple beam calculation
- Example 8 - A less simple beam calculation
- Example 9 - Calculate pile settlement (axial analysis)
- API
- Construct module
PileSectionCircularPileSectionPileLayerSoilProfileBoundaryFixationBoundaryDisplacementBoundaryForceModel- Materials module
PileMaterial- SoilModels module
API_clay_axialAPI_sand_axialBothkennar_clayCowden_clayDunkirk_sandAPI_sandAPI_clayModified_Matlock_clayReese_weakrockCustom_pisa_sandCustom_pisa_clay- winkler module
WinklerResultbeam()winkler()- py_curves module
bothkennar_clay()cowden_clay()dunkirk_sand()api_sand()api_clay()matlock_1970()modified_Matlock()reese_weakrock()custom_pisa_sand()custom_pisa_clay()- mt_curves module
bothkennar_clay()cowden_clay()dunkirk_sand()custom_pisa_sand()custom_pisa_clay()- tz_curves module
backbone_api_clay()api_clay()api_clay_kraft()backbone_api_sand()api_sand()api_sand_kraft()- qz_curves module
api_clay()api_sand()- hooks module
durkhop()durkhop_normalized()PISA_depth_variationInitialSubgradeReaction
License
Copyright (C) 2023 Guillaume Melin
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.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
Disclaimer
This open source package is primarily provided for educational and research purposes. It is not intended to replace professional engineering advice or analyses. The analyses performed using this package may not accurately represent real-world situations or account for all possible variables and conditions.
Users of this package assume all responsibility and liability for any consequences resulting from its use. The developers and contributors of this package make no warranties or guarantees, expressed or implied, regarding its accuracy, reliability, or fitness for any particular purpose.
Users should exercise caution and use their professional judgement when interpreting and applying the results generated by this package. In addition, users should be aware that the laws and regulations governing the use of finite element analyses may vary depending on their location and industry, and should comply with all applicable laws and regulations.
By using this package, users acknowledge and agree to the terms of this disclaimer.