mento 0.0.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. mento-0.0.1/LICENSE +8 -0
  2. mento-0.0.1/PKG-INFO +64 -0
  3. mento-0.0.1/README.md +41 -0
  4. mento-0.0.1/mento/__init__.py +12 -0
  5. mento-0.0.1/mento/beam.py +2566 -0
  6. mento-0.0.1/mento/column.py +0 -0
  7. mento-0.0.1/mento/forces.py +126 -0
  8. mento-0.0.1/mento/material.py +248 -0
  9. mento-0.0.1/mento/node.py +144 -0
  10. mento-0.0.1/mento/rebar.py +585 -0
  11. mento-0.0.1/mento/rectangular.py +46 -0
  12. mento-0.0.1/mento/results.py +451 -0
  13. mento-0.0.1/mento/section.py +76 -0
  14. mento-0.0.1/mento/settings.py +105 -0
  15. mento-0.0.1/mento/summary.py +358 -0
  16. mento-0.0.1/mento/units.py +39 -0
  17. mento-0.0.1/mento.egg-info/PKG-INFO +64 -0
  18. mento-0.0.1/mento.egg-info/SOURCES.txt +33 -0
  19. mento-0.0.1/mento.egg-info/dependency_links.txt +1 -0
  20. mento-0.0.1/mento.egg-info/requires.txt +8 -0
  21. mento-0.0.1/mento.egg-info/top_level.txt +1 -0
  22. mento-0.0.1/pyproject.toml +67 -0
  23. mento-0.0.1/requirements.txt +8 -0
  24. mento-0.0.1/setup.cfg +4 -0
  25. mento-0.0.1/tests/test_beam.py +399 -0
  26. mento-0.0.1/tests/test_column.py +0 -0
  27. mento-0.0.1/tests/test_forces.py +29 -0
  28. mento-0.0.1/tests/test_material.py +45 -0
  29. mento-0.0.1/tests/test_node.py +0 -0
  30. mento-0.0.1/tests/test_rebar.py +223 -0
  31. mento-0.0.1/tests/test_rectangular.py +48 -0
  32. mento-0.0.1/tests/test_results.py +83 -0
  33. mento-0.0.1/tests/test_section.py +38 -0
  34. mento-0.0.1/tests/test_settings.py +67 -0
  35. mento-0.0.1/tests/test_units.py +47 -0
mento-0.0.1/LICENSE ADDED
@@ -0,0 +1,8 @@
1
+ Copyright <2024> <Ing. Juan Pablo Romaris>
2
+ Copyright <2024> <Ing. Mihdí Caballero>
3
+
4
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5
+
6
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
7
+
8
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mento-0.0.1/PKG-INFO ADDED
@@ -0,0 +1,64 @@
1
+ Metadata-Version: 2.2
2
+ Name: mento
3
+ Version: 0.0.1
4
+ Summary: A package for structural engineering analysis
5
+ Author-email: Mihdí Caballero <mihdicaballero@gmail.com>, Juan Pablo Romaris <jpromaris@yahoo.com.ar>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/mihdicaballero/mento
8
+ Keywords: concrete design,structural engineering,structural analysis
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Operating System :: OS Independent
12
+ Requires-Python: >=3.10
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Requires-Dist: pint
16
+ Requires-Dist: pandas
17
+ Requires-Dist: seaborn
18
+ Requires-Dist: numpy
19
+ Requires-Dist: IPython
20
+ Requires-Dist: ipykernel
21
+ Requires-Dist: tabulate
22
+ Requires-Dist: python-docx
23
+
24
+ # Mento
25
+ *An intuitive tool for structural engineers to design concrete elements efficiently.*
26
+
27
+ [![Tests](https://github.com/mihdicaballero/mento/actions/workflows/tests.yml/badge.svg)][tests]
28
+ [![Docs](https://readthedocs.org/projects/mento-docs/badge/?version=latest)](https://mento-docs.readthedocs.io/en/latest/?badge=latest)
29
+ [![Codecov](https://codecov.io/gh/robbievanleeuwen/concrete-properties/branch/master/graph/badge.svg)][codecov]
30
+ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)][ruff]
31
+
32
+ [tests]: https://github.com/mihdicaballero/mento/actions/workflows/tests.yml
33
+ [ruff]: https://github.com/charliermarsh/ruff
34
+ [codecov]: https://app.codecov.io/github/mihdicaballero/mento
35
+
36
+ This repository provides a comprehensive package for the design and structural analysis of concrete sections, beams and columns. The package adheres to multiple design codes, ensuring broad applicability in structural engineering projects.
37
+
38
+ #### Features
39
+ - Check and design for flexure and shear of:
40
+ - Rectangular Concrete Beam
41
+ - Circular Concrete Column
42
+ - Rectangular Concrete Column
43
+ - Unit-sensitive design, allowing users to input variables with their respective units for accurate calculations.
44
+ - Interactive usage in Jupyter Notebooks, allowing users to create custom calculations using package modules.
45
+ - Results are presented in markdown format within the notebook and as pandas DataFrames for easy handling of multiple checks.
46
+ - Ability to generate detailed calculation reports in Word.
47
+ - Comprehensive testing for design code compliance, including ACI 318-19, EN 1992-2024, and CIRSOC 201-2024.
48
+
49
+ #### Roadmap
50
+ The development is structured around key milestones, with ongoing tasks that aim to enhance functionality and compliance with design standards:
51
+ - [x] Rectangular concrete beam section check and design for ACI 318-19 and CIRSOC 201-25.
52
+ - [ ] Rectangular concrete beam section check and design for EN 1992-2024.
53
+ - [ ] Circular concrete column section check and design for ACI 318-19.
54
+ - [ ] Circular concrete column section check and design for EN 1992-2024.
55
+ - [ ] Rectangular concrete column section check and design for ACI 318-19.
56
+ - [ ] Rectangular concrete column section check and design for EN 1992-2024.
57
+
58
+ Each milestone incorporates rigorous testing and continuous integration to ensure code quality and reliability.
59
+
60
+ #### Contributing
61
+ We welcome contributions from the community to expand and enhance the package. Please check the roadmap for current milestones and open issues for collaboration opportunities.
62
+
63
+ #### License
64
+ This project is licensed under the MIT License.
mento-0.0.1/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # Mento
2
+ *An intuitive tool for structural engineers to design concrete elements efficiently.*
3
+
4
+ [![Tests](https://github.com/mihdicaballero/mento/actions/workflows/tests.yml/badge.svg)][tests]
5
+ [![Docs](https://readthedocs.org/projects/mento-docs/badge/?version=latest)](https://mento-docs.readthedocs.io/en/latest/?badge=latest)
6
+ [![Codecov](https://codecov.io/gh/robbievanleeuwen/concrete-properties/branch/master/graph/badge.svg)][codecov]
7
+ [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)][ruff]
8
+
9
+ [tests]: https://github.com/mihdicaballero/mento/actions/workflows/tests.yml
10
+ [ruff]: https://github.com/charliermarsh/ruff
11
+ [codecov]: https://app.codecov.io/github/mihdicaballero/mento
12
+
13
+ This repository provides a comprehensive package for the design and structural analysis of concrete sections, beams and columns. The package adheres to multiple design codes, ensuring broad applicability in structural engineering projects.
14
+
15
+ #### Features
16
+ - Check and design for flexure and shear of:
17
+ - Rectangular Concrete Beam
18
+ - Circular Concrete Column
19
+ - Rectangular Concrete Column
20
+ - Unit-sensitive design, allowing users to input variables with their respective units for accurate calculations.
21
+ - Interactive usage in Jupyter Notebooks, allowing users to create custom calculations using package modules.
22
+ - Results are presented in markdown format within the notebook and as pandas DataFrames for easy handling of multiple checks.
23
+ - Ability to generate detailed calculation reports in Word.
24
+ - Comprehensive testing for design code compliance, including ACI 318-19, EN 1992-2024, and CIRSOC 201-2024.
25
+
26
+ #### Roadmap
27
+ The development is structured around key milestones, with ongoing tasks that aim to enhance functionality and compliance with design standards:
28
+ - [x] Rectangular concrete beam section check and design for ACI 318-19 and CIRSOC 201-25.
29
+ - [ ] Rectangular concrete beam section check and design for EN 1992-2024.
30
+ - [ ] Circular concrete column section check and design for ACI 318-19.
31
+ - [ ] Circular concrete column section check and design for EN 1992-2024.
32
+ - [ ] Rectangular concrete column section check and design for ACI 318-19.
33
+ - [ ] Rectangular concrete column section check and design for EN 1992-2024.
34
+
35
+ Each milestone incorporates rigorous testing and continuous integration to ensure code quality and reliability.
36
+
37
+ #### Contributing
38
+ We welcome contributions from the community to expand and enhance the package. Please check the roadmap for current milestones and open issues for collaboration opportunities.
39
+
40
+ #### License
41
+ This project is licensed under the MIT License.
mento-0.0.1/mento/__init__.py ADDED
@@ -0,0 +1,12 @@
1
+ # Expose units and Quantity directly to the user
2
+ from .units import ureg, m, cm, mm, kN, kNm, MPa, GPa, kg, sec, psi, lb, kip, ksi, inch, ft, deg # noqa: F401
3
+
4
+ # Export Quantity for user convenience
5
+ Quantity = ureg.Quantity
6
+
7
+ # Expose classes from different modules
8
+ from .node import Node # noqa: F401, E402
9
+ from .forces import Forces # noqa: F401, E402
10
+ from .material import Concrete_ACI_318_19, SteelBar # noqa: F401, E402
11
+ from .beam import RectangularBeam # noqa: F401, E402
12
+ from .results import Formatter, TablePrinter, DocumentBuilder # noqa: F401, E402