Skip to content

Commit 2d6a521

Browse files
robbievanleeuwenrobbievanleeuwen
committed
README.rst
1 parent 025f16c commit 2d6a521

File tree

3 files changed

+157
-99
lines changed

3 files changed

+157
-99
lines changed

‎README.md‎

Lines changed: 0 additions & 99 deletions
This file was deleted.

‎README.rst‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
sectionproperties
2+
=================
3+
4+
|Build Status| |Documentation Status|
5+
6+
a python package for the analysis of arbitrary cross-sections using the
7+
finite element method written by Robbie van Leeuwen. *sectionproperties*
8+
can be used to determine section properties to be used in structural
9+
design and visualise cross-sectional stresses resulting from
10+
combinations of applied forces and bending moments.
11+
12+
.. raw:: html
13+
14+
<embed>
15+
<!-- Begin Mailchimp Signup Form -->
16+
<link href="//cdn-images.mailchimp.com/embedcode/slim-10_7.css" rel="stylesheet" type="text/css">
17+
<style type="text/css">
18+
#mc_embed_signup{background:#fff; clear:left; font:14px Helvetica,Arial,sans-serif; }
19+
/* Add your own Mailchimp form style overrides in your site stylesheet or in this style block.
20+
We recommend moving this block and the preceding CSS link to the HEAD of your HTML file. */
21+
</style>
22+
<div id="mc_embed_signup">
23+
<form action="https://github.us19.list-manage.com/subscribe/post?u=541c65ecb1b23522bcf1300db&amp;id=b7a47b4e83" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate>
24+
<div id="mc_embed_signup_scroll">
25+
<label for="mce-EMAIL">Subscribe to the sectionproperties mailing list!</label>
26+
<input type="email" value="" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" required>
27+
<!-- real people should not fill this in and expect good things - do not remove this or risk form bot signups-->
28+
<div style="position: absolute; left: -5000px;" aria-hidden="true"><input type="text" name="b_541c65ecb1b23522bcf1300db_b7a47b4e83" tabindex="-1" value=""></div>
29+
<div class="clear"><input type="submit" value="Subscribe" name="subscribe" id="mc-embedded-subscribe" class="button"></div>
30+
</div>
31+
</form>
32+
</div>
33+
<!--End mc_embed_signup-->
34+
</embed>
35+
36+
Installation:
37+
-------------
38+
39+
For more detailed installation instructions, refer to the `documentation`_.
40+
41+
UNIX (MacOS/Linux):
42+
~~~~~~~~~~~~~~~~~~~
43+
44+
::
45+
46+
$ pip install sectionproperties
47+
48+
Windows
49+
~~~~~~~
50+
51+
Install *meshpy* by downloading the appropriate `installation wheel`_.
52+
53+
Navigate to the location of the downloaded wheel and install using pip:
54+
55+
::
56+
57+
$ cd Downloads
58+
$ pip install MeshPy‑2018.2.1‑cp36‑cp36m‑win_amd64.whl
59+
60+
Once *meshpy* has been installed, *sectionproperties* can be installed:
61+
62+
::
63+
64+
$ pip install sectionproperties
65+
66+
Documentation:
67+
--------------
68+
69+
*sectionproperties* has a fully documented python API which you can find
70+
at https://sectionproperties.readthedocs.io/. To read more about the
71+
theory behind the program, its implementation and some more examples,
72+
check out my blog at https://robbievanleeuwen.github.io/.
73+
74+
Current Capabilities:
75+
---------------------
76+
77+
Pre-Processor:
78+
~~~~~~~~~~~~~~
79+
80+
- [x] Python API
81+
- [x] Custom section geometry input
82+
- [x] Common section geometry generators
83+
- [x] Multiple geometry merging
84+
- [x] Geometry cleaning
85+
- [ ] JSON input file
86+
- [ ] .dxf import
87+
- [x] Quadratic triangular mesh generation
88+
- [x] Composite material properties
89+
90+
Cross-Section Analysis:
91+
~~~~~~~~~~~~~~~~~~~~~~~
92+
93+
- [x] Global axis geometric section properties:
94+
95+
- [x] Area
96+
- [x] First moments of area
97+
- [x] Second moments of area
98+
- [x] Elastic centroid
99+
- [x] Centroidal axis geometric section properties:
100+
- [x] Second moments of area
101+
- [x] Elastic section moduli
102+
- [ ] Yield moment
103+
- [x] Radii of gyration
104+
- [x] Plastic centroid
105+
- [x] Plastic section moduli
106+
- [x] Shape factors
107+
- [x] Principal axis geometric section properties:
108+
- [x] Second moments of area
109+
- [x] Elastic section moduli
110+
- [ ] Yield moment
111+
- [x] Radii of gyration
112+
- [x] Plastic centroid
113+
- [x] Plastic section moduli
114+
- [x] Shape factors
115+
- [x] Warping section properties:
116+
- [x] Torsion constant
117+
- [x] Warping constant
118+
- [x] Shear section properties:
119+
- [x] Shear centre (elastic method)
120+
- [x] Shear centre (Trefftz’s method)
121+
- [x] Shear areas (global axis)
122+
- [x] Shear areas (principal axis)
123+
- [x] Cross-section stresses
124+
125+
Solver:
126+
~~~~~~~
127+
128+
- [x] Direct solver
129+
- [x] CGS iterative solver
130+
- [x] Sparse matrices
131+
132+
Post-Processor:
133+
~~~~~~~~~~~~~~~
134+
135+
- [x] Plot geometry
136+
- [x] Plot mesh
137+
- [x] Plot centroids
138+
- [x] Plot cross-section stresses
139+
- [ ] Generate cross-section report
140+
- [ ] Export to Paraview
141+
142+
Additional Modules:
143+
~~~~~~~~~~~~~~~~~~~
144+
145+
- [ ] Optimisation
146+
- [ ] Reinforced Concrete
147+
- [ ] Steel
148+
149+
.. _documentation: https://sectionproperties.readthedocs.io/
150+
.. _installation wheel: https://www.lfd.uci.edu/~gohlke/pythonlibs/#meshpy
151+
152+
.. |Build Status| image:: https://travis-ci.com/robbievanleeuwen/section-properties.svg?branch=master
153+
:target: https://travis-ci.com/robbievanleeuwen/section-properties
154+
.. |Documentation Status| image:: https://readthedocs.org/projects/sectionproperties/badge/?version=latest
155+
:target: https://sectionproperties.readthedocs.io/en/latest/?badge=latest

‎todo.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# TODO LIST:
2+
- [ ] Change README to rst for pypi rendering

0 commit comments

Comments
 (0)