Merge pull request #181 from robbievanleeuwen/rtd-pdf

Enable rtd pdf; make examples faster

Author: robbievanleeuwen

.readthedocs.yaml

@@ -12,7 +12,7 @@ sphinx:
    configuration: docs/source/conf.py
 
 # # Default is HTML
-# formats: []
+formats: all
 
 # Optionally declare the Python requirements required to build your docs
 python:

docs/source/conf.py

@@ -177,15 +177,6 @@
 
 # --- Sphinx-Gallery options -----------------------------------------------------------------------
 
-
-class matplotlib_svg_scraper(object):
-    def __repr__(self):
-        return self.__class__.__name__
-
-    def __call__(self, *args, **kwargs):
-        return matplotlib_scraper(*args, format="svg", **kwargs)
-
-
 sphinx_gallery_conf = {
     # convert rst to md for ipynb
     "pypandoc": False,
@@ -203,7 +194,7 @@ def __call__(self, *args, **kwargs):
     "backreferences_dir": None,
     # Modules for which function level galleries are created.  In
     "doc_module": "sectionproperties",
-    "image_scrapers": (matplotlib_svg_scraper(),),
+    "image_scrapers": ("matplotlib",),
     "first_notebook_cell": ("%matplotlib inline\n"),
 }
 

docs/source/rst/theory.rst

@@ -98,7 +98,6 @@ are as follows:
   N_4 &= 4 \eta \xi \\
   N_5 &= 4 \xi \zeta \\
   N_6 &= 4 \eta \zeta
-  :label: eq-shape-functions
 
 
 The above shape functions can be combined into the shape function row vector:
@@ -132,14 +131,13 @@ and the partial derivative matrix (:math:`\textbf{P}`):
     1 & 0 \\
     0 & 1 \\
   \end{bmatrix}
-  :label: eq-JP
 
 The determinant of the *Jacobian matrix* scaled by one half is equal to the Jacobian:
 
 .. math::
   J = \frac{1}{2} \textrm{det} \, \textbf{J}
 
-Equation :eq:`eq-JP` can be re-arranged to evaluate the partial derivate matrix
+The equation for \textbf{J P} can be re-arranged to evaluate the partial derivate matrix
 (:math:`\textbf{P}`):
 
 .. math::
@@ -166,7 +164,7 @@ expressions:
   \end{bmatrix}
 
 where the derivatives of the shape functions with respect to the isoparametric parameters can
-easily be evaluated from Equation :eq:`eq-shape-functions`, resulting in the following expression
+easily be evaluated from the equation for the shape functions, resulting in the following expression
 for the :math:`\textbf{B}` matrix:
 
 .. math::

examples/00-basic/08_frame.py

@@ -28,7 +28,7 @@
 
 # %%
 # Create a list of mesh sizes to analyse
-mesh_sizes = [1.5, 2, 2.5, 3, 4, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100]
+mesh_sizes = [3, 4, 5, 10, 15, 20, 25, 30, 40, 50, 75, 100, 200]
 j_calc = []  # list to store torsion constants
 t_calc = []  # list to store computation times
 

examples/01-advanced/02_mesh_refinement.py

@@ -21,8 +21,8 @@
 
 # %%
 # Define mesh sizes
-mesh_size_list = [50, 20, 10, 5, 3, 2, 1]
-nr_list = [4, 8, 12, 16, 20, 24, 32, 64]
+mesh_size_list = [200, 100, 50, 20, 10, 5]
+nr_list = [4, 8, 12, 16, 20, 24, 32]
 
 # %%
 # Initialise result lists
@@ -33,17 +33,17 @@
 
 # %%
 # Calculate reference solution
-geometry = steel_sections.i_section(d=203, b=133, t_f=7.8, t_w=5.8, r=8.9, n_r=64)
-geometry.create_mesh(mesh_sizes=[0.5])  # create mesh
+geometry = steel_sections.i_section(d=203, b=133, t_f=7.8, t_w=5.8, r=8.9, n_r=32)
+geometry.create_mesh(mesh_sizes=[5])  # create mesh
 section = Section(geometry)  # create a Section object
 section.calculate_geometric_properties()
 section.calculate_warping_properties()
 j_reference = section.get_j()  # get the torsion constant
 
 # %%
-# Run through mesh_sizes with n_r = 16
+# Run through mesh_sizes with n_r = 8
 for mesh_size in mesh_size_list:
-    geometry = steel_sections.i_section(d=203, b=133, t_f=7.8, t_w=5.8, r=8.9, n_r=16)
+    geometry = steel_sections.i_section(d=203, b=133, t_f=7.8, t_w=5.8, r=8.9, n_r=8)
     geometry.create_mesh(mesh_sizes=[mesh_size])  # create mesh
     section = Section(geometry)  # create a Section object
     section.calculate_geometric_properties()
@@ -53,10 +53,10 @@
     mesh_results.append(section.get_j())
 
 # %%
-# Run through n_r with mesh_size = 3
+# Run through n_r with mesh_size = 10
 for n_r in nr_list:
     geometry = steel_sections.i_section(d=203, b=133, t_f=7.8, t_w=5.8, r=8.9, n_r=n_r)
-    geometry.create_mesh(mesh_sizes=[3])  # create mesh
+    geometry.create_mesh(mesh_sizes=[10])  # create mesh
     section = Section(geometry)  # create a Section object
     section.calculate_geometric_properties()
     section.calculate_warping_properties()

examples/01-advanced/03_torsion_constant.py

@@ -26,7 +26,7 @@
 
 # %%
 # Number of elements for each analysis
-n = 500
+n = 100
 
 # %%
 # Loop through all the widths

sectionproperties/analysis/section.py

@@ -793,7 +793,7 @@ def calculate_frame():
         )
 
     def calculate_plastic_properties(self, verbose=False, debug=False):
-        """Calculates the plastic properties of the cross-section and stores the, in the
+        """Calculates the plastic properties of the cross-section and stores them in the
         :class:`~sectionproperties.analysis.section.SectionProperties` object contained in
         the ``section_props`` class variable.