Doc update

docs/eurocodedesign.constants.rst

@@ -0,0 +1,10 @@
+eurocodedesign.constants package
+================================
+
+Module contents
+---------------
+
+.. automodule:: eurocodedesign.constants
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/eurocodedesign.standard.ec3.steel_bridges.rst

@@ -0,0 +1,21 @@
+eurocodedesign.standard.ec3.steel\_bridges package
+==================================================
+
+Submodules
+----------
+
+eurocodedesign.standard.ec3.steel\_bridges.fatigue module
+---------------------------------------------------------
+
+.. automodule:: eurocodedesign.standard.ec3.steel_bridges.fatigue
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: eurocodedesign.standard.ec3.steel_bridges
+   :members:
+   :show-inheritance:
+   :undoc-members:

docs/index.rst

@@ -7,7 +7,7 @@ Welcome to eurocodedesign's documentation!
 
    readme
    installation
-   usage
+   usage/index
    modules
    contributing
    authors

docs/usage/ec3.rst

@@ -0,0 +1,82 @@
+######################################
+Eurocode 3: Design of steel structures
+######################################
+
+*********************
+Implementation status
+*********************
+
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| Standard         | Title                                                                                      |   Status         |
++==================+============================================================================================+==================+
+| EN 1993-1-1      | General rules and rules for buildings                                                      |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-2      | General rules - Structural fire design                                                     |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-3      | General rules - Supplementary rules for cold-formed members and sheeting                   |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-4      | General rules - Supplementary rules for stainless steels                                   |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-5      | General rules - Plated structural elements                                                 |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-6      | General rules - Strength and stability of shell structures                                 |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-7      | General rules - Strength and stability of planar plated structures subject to              |                  |
+|                  | out of plane loading                                                                       |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-8      | Design of joints                                                                           |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-9      | Fatigue                                                                                    |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-10     | Material toughness and through-thickness properties                                        |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-11     | Design of structures with tension components                                               |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-1-12     | General - High strength steels                                                             |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-2        | Steel bridges                                                                              |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-3-1      | Towers, masts and chimneys – Towers and masts                                              |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-3-2      | Towers, masts and chimneys – Chimneys                                                      |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-4-1      | Silos                                                                                      |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-4-2      | Storage tanks                                                                              |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-4-3      | Pipelines                                                                                  |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-5        | Deep foundation (piling)                                                                   |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+| EN 1993-6        | Crane supporting structures                                                                |                  |
++------------------+--------------------------------------------------------------------------------------------+------------------+
+
+
+**************************************************
+EN 1993-1-1: General rules and rules for buildings
+**************************************************
+
+Safety factors and crosssection is partly implemented
+
+
+*******************************************************
+EN 1993-1-5: General rules - Plated structural elements
+*******************************************************
+
+§ 4-7: Effective width method
+============================
+
+
+
+§ 10: Reduced stress method
+===========================
+
+
+
+
+**************************
+EN 1993-2: Steel bridges
+**************************
+
+§ 9: Fatigue
+============

docs/usage.rst → docs/usage/gettingstarted.rst

@@ -1,5 +1,5 @@
 =====
-Usage
+Getting started
 =====
 
 To use eurocodedesign in a project::

docs/usage/index.rst

@@ -0,0 +1,16 @@
+Usage
+==========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   usage
+   namingconvention
+   ec3
+
+Indices and tables
+==================
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/usage/namingconvention.rst

@@ -0,0 +1,14 @@
+=================
+Naming convention
+=================
+
+The naming convention in eurocodedesign tries to follow the eurocode naming convention as closely as possible, while
+being restrained to valid python names and using only alphanumerical characters.
+
+* First letter is uppercase if the symbol is uppercase in eurocode, e.g. ``F_Ed``
+* Commas in subscript are neglected, except for ``Ed`` and ``Rd``, where it is replaced by an underscore, e.g. ``F_z_Ed, M_BV_Rd, M_cB_Rd, M_pl_Rd``
+* Subscript is added with an underscore before the subscript, e.g. ``M_I_Ed``
+* Only alphanumerical names are valid, greek letters are written out, e.g. ``Delta_M_y_Ed, Phi_LT, alpha_crop, alpha_ultk``
+* Variable names with a bar, like relative slenderness, are written as ``bar_lambda_czmod``
+* Other examples are ``phi_0, Chi_LT, psi``
+