sdypy-model 0.1.0__tar.gz

sdypy_model-0.1.0/.github/workflows/pytest.yaml

@@ -0,0 +1,32 @@
+name: Testing
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install flake8 pytest
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+      - name: Test with pytest
+        run: |
+          pytest

sdypy_model-0.1.0/.github/workflows/release_and_publish_on_pypi.yaml

@@ -0,0 +1,28 @@
+name: Release and Publish to PyPI
+on:
+  push:
+    tags:
+      - 'v*'
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install -U build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.4.2
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

sdypy_model-0.1.0/.gitignore

@@ -0,0 +1,109 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+.static_storage/
+.media/
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/build/
+docs/source/api/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# VSCode
+.vscode/

sdypy_model-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,78 @@
+Contributing Guide
+==================
+
+Contributions are welcome and greatly appreciated!
+
+
+.. _contributing-workflow-label:
+
+Workflow
+--------
+
+A bug-fix or enhancement is delivered using a pull request. A good pull request
+should cover one bug-fix or enhancement feature. This ensures the change set is
+easier to review and less likely to need major re-work or even be rejected.
+
+The workflow that developers typically use to fix a bug or add enhancements
+is as follows.
+
+* Fork the ``sdypy_template_project`` repo into your account.
+
+* Obtain the source by cloning it onto your development machine.
+
+  .. code-block:: console
+
+      $ git clone ttps://github.com/sdypy/sdypy_template_project.git
+      $ cd sdypy_template_project
+
+* Create a branch for local development:
+
+  .. code-block:: console
+
+      $ git checkout -b name-of-your-bugfix-or-feature
+
+  Now you can make your changes locally.
+
+
+* Develop fix or enhancement:
+
+  * Make a fix or enhancement (e.g. modify a class, method, function, module,
+    etc).
+
+  * Update an existing unit test or create a new unit test module to verify
+    the change works as expected.
+
+  * Run the test suite.
+
+    .. code-block:: console
+
+        $ pytest
+
+
+* The docs should be updated for anything but trivial bug fixes. 
+
+
+Perform docs check.
+
+    .. code-block:: console
+
+        $ cd docs
+        $ make clean
+        $ make html
+
+
+* Commit and push changes to your fork.
+
+  .. code-block:: console
+
+      $ git add .
+      $ git commit -m "A detailed description of the changes."
+      $ git push origin name-of-your-bugfix-or-feature
+
+  A pull request should preferably only have one commit upon the current
+  master HEAD, (via rebases and squash).
+
+* Submit a pull request through the service website (e.g. Github, Gitlab).
+
+* Check automated continuous integration steps all pass. Fix any problems
+  if necessary and update the pull request.

sdypy_model-0.1.0/License

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Klemen Zaletelj 2024
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

sdypy_model-0.1.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: sdypy-model
+Version: 0.1.0
+Summary: System modeling, including lumped mass and FEM.
+Project-URL: homepage, https://github.com/sdypy/sdypy-model
+Project-URL: documentation, https://github.com/sdypy/sdypy-model
+Project-URL: source, https://github.com/sdypy/sdypy-model
+Author-email: "Klemen Zaletelj et al." <klemen.zaletelj@fs.uni-lj.si>
+Maintainer-email: "Klemen Zaletelj et al." <klemen.zaletelj@fs.uni-lj.si>
+License-Expression: MIT
+Keywords: FEM,System model,lumped mass
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: gmsh
+Requires-Dist: meshio
+Requires-Dist: numpy>=1.14.3
+Requires-Dist: pylump
+Requires-Dist: pyqt5
+Requires-Dist: pyvista
+Requires-Dist: pyvistaqt
+Requires-Dist: scipy>=1.1.0
+Requires-Dist: tqdm>=4.23.4
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: myst-parser; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: sphinx; extra == 'dev'
+Requires-Dist: sphinx-book-theme; extra == 'dev'
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Requires-Dist: wheel; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# `sdypy-model`
+
+A namespace Python package for the SDyPy project.
+
+The package currently contains the following finite elements:
+
+- `beam`: Euler-Bernoulli and Timoshenko beam elements.
+- `shell`: MITC4 shell elements.
+- `tet`: Quadratic (10 node) tetrahedral elements.
+
+**Note**: The package is still under development and may not be fully functional.
+
+## Beam elements
+
+```python
+import sdypy as sd
+
+beam_obj = sd.model.Beam(...)
+
+M = beam_obj.M
+K = beam_obj.K
+```
+
+## Shell elements
+
+```python
+import sdypy as sd
+
+shell_obj = sd.model.Shell(...)
+
+M = shell_obj.M
+K = shell_obj.K
+```
+
+## Tetrahedral elements
+```python
+
+import sdypy as sd
+
+tet_obj = sd.model.Tetrahedron(...)
+
+M = tet_obj.M
+K = tet_obj.K
+```
+
+# Disclaimer
+
+This software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
+
+Use of this software is at your own risk.
+
+This software is distributed under the terms of the MIT License. See the LICENSE file for more details.

sdypy_model-0.1.0/README.md

@@ -0,0 +1,52 @@
+# `sdypy-model`
+
+A namespace Python package for the SDyPy project.
+
+The package currently contains the following finite elements:
+
+- `beam`: Euler-Bernoulli and Timoshenko beam elements.
+- `shell`: MITC4 shell elements.
+- `tet`: Quadratic (10 node) tetrahedral elements.
+
+**Note**: The package is still under development and may not be fully functional.
+
+## Beam elements
+
+```python
+import sdypy as sd
+
+beam_obj = sd.model.Beam(...)
+
+M = beam_obj.M
+K = beam_obj.K
+```
+
+## Shell elements
+
+```python
+import sdypy as sd
+
+shell_obj = sd.model.Shell(...)
+
+M = shell_obj.M
+K = shell_obj.K
+```
+
+## Tetrahedral elements
+```python
+
+import sdypy as sd
+
+tet_obj = sd.model.Tetrahedron(...)
+
+M = tet_obj.M
+K = tet_obj.K
+```
+
+# Disclaimer
+
+This software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.
+
+Use of this software is at your own risk.
+
+This software is distributed under the terms of the MIT License. See the LICENSE file for more details.

sdypy_model-0.1.0/docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+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)

sdypy_model-0.1.0/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
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

sdypy_model-0.1.0/docs/source/code.rst

@@ -0,0 +1,3 @@
+Code documentation
+==================
+

sdypy_model-0.1.0/docs/source/conf.py

@@ -0,0 +1,207 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'SDyPy-model'
+copyright = '2024, Klemen Zaletelj, Janko Slavič, Domen Gorjup'
+author = 'Klemen Zaletelj, Janko Slavič, Domen Gorjup'
+
+# The short X.Y version
+version = '0.1'
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'myst_parser',
+    'sphinx_copybutton',
+]
+
+# Defined here: https://sphinx-copybutton.readthedocs.io/en/latest/use.html#using-regexp-prompt-identifiers (the >>> are not copied)
+copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
+copybutton_prompt_is_regexp = True
+
+autodoc_default_options = {
+    'members': True,
+    'private-members': True,
+    'special-members': '__init__',
+    'member-order': 'bysource',
+    'show-inheritance': None,
+}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+source_suffix = {'.rst': 'restructuredtext', '.md': 'restructuredtext'}
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "English"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_book_theme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+    "repository_branch": "master",
+    "navigation_with_keys": True,
+    "repository_url": "https://github.com/sdypy/sdypy-model",
+    "use_repository_button": True,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sdypy_model_project_doc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    'papersize': 'a4paper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'sdypy_model_project.tex', 'SDyPy-model project Documentation',
+     'Klemen Zaletelj, Janko Slavič, Domen Gorjup', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'sdypy_model_project', 'SDyPy-model Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'SDyPy-model', 'SDyPy-model Documentation',
+     author, 'SDyPy-model', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Configuration for MyST parser (markdown in sphinx) ----------------------
+# see https://myst-parser.readthedocs.io/en/latest/ for more information
+myst_enable_extensions = [
+    "dollarmath",  # For LaTeX-style math in Markdown
+    "colon_fence", # For block directives using `::`
+]

sdypy_model-0.1.0/docs/source/getting_started.rst

@@ -0,0 +1,6 @@
+Getting started
+===============
+
+.. include:: ../../README.rst
+
+.. include:: ../../CONTRIBUTING.rst