Merge v2 development branch into master

Merge v2 branch into master 🙌

Author: robbievanleeuwen

CODE_OF_CONDUCT.md .github/CODE_OF_CONDUCT.mdCODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

@@ -11,7 +11,7 @@ appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
 
-Examples of behavior that contributes to creating a positive environment
+Examples of behaviour that contributes to creating a positive environment
 include:
 
 * Using welcoming and inclusive language
@@ -20,9 +20,9 @@ include:
 * Focusing on what is best for the community
 * Showing empathy towards other community members
 
-Examples of unacceptable behavior by participants include:
+Examples of unacceptable behaviour by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
+* The use of sexualised language or imagery and unwelcome sexual attention or
  advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
@@ -34,13 +34,13 @@ Examples of unacceptable behavior by participants include:
 ## Our Responsibilities
 
 Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
 
 Project maintainers have the right and responsibility to remove, edit, or
 reject comments, commits, code, wiki edits, issues, and other contributions
 that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
+permanently any contributor for other behaviours that they deem inappropriate,
 threatening, offensive, or harmful.
 
 ## Scope
@@ -54,7 +54,7 @@ further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
 reported by contacting the project team at robbie.vanleeuwen@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is

.github/CONTRIBUTING.md

@@ -0,0 +1 @@
+TBC...

.github/workflows/black.yml

@@ -0,0 +1,17 @@
+name: Lint with Black
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: psf/black@stable
+        with:
+          options: "--check --verbose"

.github/workflows/build_deploy.yml

@@ -0,0 +1,47 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Build and Deploy
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.9'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+
+    - name: Build a binary wheel and a source tarball
+      run: python -m build --sdist --wheel --outdir dist/
+
+    # uncomment to publish to TestPyPI
+    # - name: Publish distribution to Test PyPI
+    #   uses: pypa/gh-action-pypi-publish@master
+    #   with:
+    #     password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+    #     repository_url: https://test.pypi.org/legacy/
+
+    # uncomment to publish to PyPI
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/code_coverage.yml

@@ -0,0 +1,37 @@
+name: Code Coverage
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.8' ]
+
+    name: Code coverage with python ${{ matrix.python-version }}
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Update pip
+      run: pip install --upgrade pip
+
+    - name: Install package
+      run: python -m pip install -e .
+
+    - name: Generate report
+      run: |
+        pip install pytest-cov
+        pytest --cov=./ --cov-report=xml
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2.1.0

.github/workflows/tests.yml

@@ -0,0 +1,34 @@
+name: Run Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.7', '3.8', '3.9']
+
+    name: Runs tests with python ${{ matrix.python-version }} using ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Update pip
+      run: pip install --upgrade pip
+
+    - name: Install package
+      run: python -m pip install -e .
+
+    - name: Run package tests
+      run: python -m pytest

.gitignore

@@ -11,6 +11,7 @@
 
 # doc generated
 /docs/build
+/docs/source/sphinx_gallery_examples/
 
 # Python egg metadata, regenerated from source files by setuptools.
 /*.egg-info

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Default is HTML
+formats:
+  - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/source/requirements_docs.txt

.travis.yml

@@ -1,5 +1,75 @@
-Change Log:
-===========
+Changelog:
+==========
+
+v2.0.0:
+-------
+
+*sectionproperties* v2 incorporates significant changes to the pre-processor, which now uses the
+`Shapely <https://github.com/shapely/shapely>`_ package to power advanced geometry creation and
+manipulation, and vastly improves the performance and robustness of the plastic section property
+algorithm. v2.x.x introduces many breaking changes from v1.x.x when creating and manipulating
+``Geometry``, refer to the `documentation <https://sectionproperties.readthedocs.io>`_ for more
+information.
+
+Pre-Processor:
+^^^^^^^^^^^^^^
+
+A special mention to `@connorferster <https://github.com/connorferster>`_ for a majority of these
+fantastic additions!
+
+- ``sections.py`` renamed to ``geometry.py``
+- All ``Geometry`` objects are defined by a shapely ``Polygon``
+- Addition of new geometry manipulation methods and geometry set operators
+- Added .dxf import, thanks to `@aegis1980 <https://github.com/aegis1980>`_
+- Added .3dm import, thanks to `@normanrichardson <https://github.com/normanrichardson>`_
+- Introduction of a ``CompoundGeometry`` class for geometries with multiple regions
+- ``Geometry`` objects are assigned a ``Material`` property object, ``CompoundGeometry`` objects
+  can contain multiple ``Geometry`` objects (each with their own ``Material`` object) 
+  enabling composite analysis
+- ``Geometry`` and ``CompoundGeometry`` objects contain mesh information and meshing must be
+  performed before initialising a ``Section`` object
+- Improved ``.offset_perimeter()`` logic
+- Meshing is now performed by `triangle <https://github.com/drufat/triangle>`_, *meshpy* is no
+  longer a dependency
+- ``Material`` class now requires a ``.density`` parameter
+- The section library (``sectionproperties.pre.library``) now contains the built-in
+  *sectionproperties* geometries
+- Added ``triangular_section()`` and ``triangular_radius_section()`` to the ``primitive_sections``
+  library
+- Added ``concrete_sections`` library - contains ``concrete_rectangular_section()``,
+  ``concrete_tee_section()`` and ``concrete_circular_section()``
+- Added ``bridge_section`` library, thanks to `@ccaprani <https://github.com/ccaprani>`_ - contains
+  ``super_t_girder_section()`` and ``i_girder_section()``
+
+Analysis:
+^^^^^^^^^
+
+- ``cross_section.py`` renamed to ``section.py``
+- ``CrossSection`` object renamed to ``Section`` and is now initialised with only a ``Geometry`` or
+  ``CompoundGeometry`` object
+- Added calculation of cross-section mass
+- Added calculation of weighted material properties - E_eff, G_eff, nu_eff
+- The plastic algorithm is now performed by shapely, improving performance and robustness
+- Added calculation of principal stresses, thanks to `@ccaprani <https://github.com/ccaprani>`_
+- Shape factors are no longer calculated for composite sections (irrelevant property)
+
+Post-Processor:
+^^^^^^^^^^^^^^
+
+- Improved contour plotting behaviour
+- Added plotting of Mohr's circle of stresses for any given point, thanks to
+  `@ccaprani <https://github.com/ccaprani>`_
+- ``.display_results()`` now reports E.J and E.Iw instead of G.J and G.Iw
+- ``.display_results()`` now reports modulus weighted shear areas for composite sections
+
+Misc.:
+^^^^^^
+
+- Many spelling and code style fixes, thanks to `@Spectre5 <https://github.com/Spectre5>`_
+- Updated documentation to include theoretical background
+- Updated examples to be performed by sphinx-gallery, thanks to
+  `@normanrichardson <https://github.com/normanrichardson>`_ and
+  `@Spectre5 <https://github.com/Spectre5>`_
 
 v1.0.8:
 -------
@@ -33,7 +103,7 @@ v1.0.5:
 -------
 
 - Added calculation of monosymmetric constants
-- Added tapered flange I-section and channel sections
+- Added tapered flange I Section and channel sections
 - Added solid elliptical and hollow elliptical sections (BenjaminFraser)
 - Added polygonal section (Agent6-6-6)
 - Handle zero radius for all section classes; handle r_out < t for relevant sections
@@ -42,7 +112,7 @@ v1.0.5:
 v1.0.4:
 -------
 
-- Added a monosymmetric I-section class
+- Added a monosymmetric I Section class
 - Extend the plastic centroid search range to the entire section
 - Remove the pc_region variable from the plastic centroid calculation as it is no longer relevant
 - Better verbose output for the plastic centroid calculation