Add benchmark histogram option, add benchmark info to contributing

Author: robbievanleeuwen

.gitignore

@@ -41,3 +41,6 @@ __pycache__/
 
 # Jupyter Notebook
 .ipynb_checkpoints
+
+# benchmark results
+.benchmarks

CONTRIBUTING.md

@@ -121,6 +121,22 @@ nox --session=tests
 Unit tests are located in the _tests_ directory, and are written using the [pytest]
 testing framework.
 
+### Benchmarks
+
+If the code you are modifying may affect the performance of `sectionproperties`, it is
+recommended that you run the benchmarking tests to verify the performance before and
+after your changes. There are three different benchmarking suites: `geometry`, `meshing`
+and `analysis`. These can be run like this:
+
+```shell
+poetry run pytest -m benchmark_geom
+poetry run pytest -m benchmark_mesh
+poetry run pytest -m benchmark_analysis
+```
+
+Note that a plot of the results can be generated by adding the `--benchmark-histogram`
+option to the above commands.
+
 [pytest]: https://pytest.readthedocs.io/
 
 ## How to submit changes

docs/contributing.rst

@@ -129,6 +129,23 @@ this:
 Unit tests are located in the *tests* directory, and are written using
 the `pytest <https://pytest.readthedocs.io/>`__ testing framework.
 
+Benchmarks
+^^^^^^^^^^
+
+If the code you are modifying may affect the performance of ``sectionproperties``, it is
+recommended that you run the benchmarking tests to verify the performance before and
+after your changes. There are three different benchmarking suites: ``geometry``,
+``meshing`` and ``analysis``. These can be run like this:
+
+.. code:: shell
+
+   poetry run pytest -m benchmark_geom
+   poetry run pytest -m benchmark_mesh
+   poetry run pytest -m benchmark_analysis
+
+Note that a plot of the results can be generated by adding the ``--benchmark-histogram``
+option to the above commands.
+
 How to submit changes
 ---------------------
 

poetry.lock

@@ -82,7 +82,7 @@ pre-commit = "^3.4.0"
 pre-commit-hooks = "^4.5.0"
 Pygments = "^2.16.1"
 pytest = "^7.4.2"
-pytest-benchmark = "^4.0.0"
+pytest-benchmark = { extras = ["histogram"], version = "^4.0.0" }
 pytest-check = "^2.2.2"
 pyupgrade = "^3.15.0"
 sphinx = "^7.2.6"

pyproject.toml

@@ -73,8 +73,12 @@ def chs_geom() -> Geometry:
 def concrete_column_with_hole(concrete, steel) -> Callable:
     """Creates a concrete column with a hole at its centre.
 
-    Return:
-        Geometry
+    Args:
+        concrete: Concrete material
+        steel: Steel material
+
+    Returns:
+        Generator function
     """
 
     def _generate_geom() -> Geometry:
@@ -100,7 +104,11 @@ def _generate_geom() -> Geometry:
 
 @pytest.fixture
 def analysis_geometry() -> Callable:
-    """Create a geometry to be used for analysis."""
+    """Create a geometry to be used for analysis.
+
+    Returns:
+        Generator function
+    """
 
     def _generate_geom(num_elements: int) -> Geometry:
         mat_a = Material("a", 1, 0, 1, 1, color="b")