Python implementation of Truss Analysis

.github/workflows/deploy.yaml

@@ -0,0 +1,35 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main  # Replace with your default branch if it's not 'main'
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check Out Repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install sphinx
+
+      - name: Build Documentation
+        run: |
+          cd docs
+          make html
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html

.gitignore

@@ -0,0 +1,25 @@
+# directories
+*/*.egg-info/
+.ipynb_checkpoints/
+Lectures/src/.vscode/
+.vscode/
+
+
+
+# latex 
+*.vrb
+*.toc
+*.snm
+*.out
+*.nav
+*.gz
+*.log
+*.aux
+*.glo
+*.ist
+*.acn
+*.synctex(busy)
+*.pyc
+Lectures/*/*.pdf
+/.pytest_cache/
+/docs/build/

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "python.testing.pytestArgs": [
+        "src"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "esbonio.sphinx.confDir": ""
+}

README.md

@@ -138,4 +138,5 @@ In example 2, all members properties are **E = 200 GPa** and **A = 0.0015 m^2^**
 
 ## Author
 
-- Eduardo Pereira
+- Eduardo Pereira (original MATLAB/GNU Octave version)
+- Nikolaos Papadakis (Python implementation)

TODO.md

@@ -0,0 +1,21 @@
+
+## TODO
+- CLEANUP: Streamline code (use np.arrays for easier slicing etc)
+- CLEANUP: plotter functions could use a lot of cleanup (i.e. move the Mesh, Displacement 
+and Solution objects into the _plot_functions)
+- DOC: add documentation for all methods
+- DOC: add documentation for classes
+- DOC: add quickstart guide
+- CLEANUP: use the roots __init__.py imports to simplify the import statements
+
+## History 
+- 20240128|ORG: Upload package to Pypi
+- 20240128|DOC: add documentation with example cases
+
+- 20240128| ORG: USe single source of truth for versioning
+- 20240128| FEATURE: complete conversion of PlotDeformation
+- 20240128| FEATURE: complete conversion of PlotStress
+- 20240128| FEATURE: Provide alternative ways to load data (e.g. json, directly with np.arrays)
+- 20240127| ORG: Create a master class that performs seemleasly all the code (e.g. TrussProblem or similar).
+- 20240127| ORG: Create a python package
+

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/readme.md

@@ -0,0 +1,4 @@
+There are many problems that can be used for validation in 
+
+# https://mathalino.com/reviewer/engineering-mechanics/problem-004-mj-method-joints
+

docs/source/background.rst

@@ -0,0 +1,6 @@
+Truss Analysis Bakcground
+=========================
+
+This section is work in progress. 
+
+It will be used to explain the truss solving process. 

docs/source/conf.py

@@ -0,0 +1,64 @@
+
+import os 
+import sys 
+sys.path.insert(0, os.path.abspath('../src'))
+
+def get_version(rel_path):
+    """Get the version string from a file.
+    Assuming the version line is in the form: __version__ = '0.1.0'
+    strips out the version and remove leading and trailing whitespace and quotes
+    Args:
+        rel_path (str): The relative path to the file.
+Raises:
+    RuntimeError: If the version string is not found.
+
+	Returns:
+        str: The version string.
+    """
+
+    with open(rel_path, 'r', encoding='utf-8') as fp:
+        for line in fp:
+            if line.startswith('__version__'):
+                delim = '"' if '"' in line else "'"
+                return line.split(delim)[1]
+    raise RuntimeError("Unable to find version string.")
+
+PATH_TO_INIT_PY = '../../src/npp_2d_truss_analysis/__init__.py'
+
+__version__ = get_version(PATH_TO_INIT_PY)
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'NPP 2d Truss Analysis'
+copyright = '2024, Nikolaos Papadakis'
+author = 'Nikolaos Papadakis'
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']
+
+
+
+rst_epilog = """
+.. |ProjectVersion| replace:: v{versionnum}
+""".format(versionnum = release
+)

docs/source/index.rst

@@ -0,0 +1,25 @@
+.. NPP 2d Truss Analysis documentation master file, created by
+   sphinx-quickstart on Mon Jan 29 09:58:27 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to NPP 2d Truss Analysis's |ProjectVersion| documentation!
+==================================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction
+   background
+   installation
+   tutorials/index
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/installation.rst

@@ -0,0 +1,42 @@
+
+Installation/Setup
+==================
+
+Requirements
+------------
+
+The package depends on the following "standard" libraries:
+
+- matplotlib
+- scipy
+- numpy
+
+
+Conda Installation
+------------------
+
+The following describes a minimum environment setup using Conda.
+
+(Optional) It is preferable to create a new environment for the packages:
+
+.. code-block:: bash
+
+    conda create -n truss_analysis python=3
+
+The installation requires:
+
+- matplotlib
+- scipy
+- numpy 
+
+To install these packages, use the command:
+
+.. code-block:: bash
+
+    conda install matplotlib scipy numpy
+
+Then ton install the package, use the command:
+
+.. code-block:: bash
+
+    pip install npp_2d_truss_analysis

docs/source/introduction.rst

@@ -0,0 +1,20 @@
+Introduction
+------------
+
+**npp_2d_truss_analysis** is an open-source software tool designed for the  solving of trusses with features like:
+
+-  inclined roller supports
+-  offset pin supports
+-  prescribed displacements
+-  plotting of Truss problem (with geometry, loads and supports)
+-  deformation plotting
+-  forces and reaction plotting
+
+Developers
+----------
+
+The python version of the truss analysis project has been developed by:
+
+- N. Papadakis: In charge of software design and package maintenance.
+
+the work is based on Eduaardo's Pereira's repoistory for matlab called [TrussAnalysis2d-MATLAB](https://github.com/edurodriper/TrussAnalysis2D-MATLAB).

docs/source/tutorials/index.rst

@@ -0,0 +1,18 @@
+Tutorials
+=========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorials:
+
+   quickstart
+   tutorial_original_input
+   tutorial_json_input
+   tutorial_single_file_json
+
+
+Additional things to consider:
+
+- how to update input for forces
+
+- plotting only truss without the solution