pystran 0.0.1__tar.gz

pystran-0.0.1/.github/workflows/pubflow.yml

@@ -0,0 +1,52 @@
+name: Publish Python 🐍 distribution 📦 to PyPI and TestPyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/<package-name>  # Replace <package-name> with your PyPI project name
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution 📦 to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

pystran-0.0.1/.github/workflows/sphinx.yml

@@ -0,0 +1,47 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Build-sphinx-docs
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      # Runs a single command using the runners shell
+      - name: Run a one-line script
+        run: echo Hello, world!
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r doc_requirements.txt
+      - name: Build HTML
+        run: |
+          sphinx-apidoc -o docs/source pystran/ -e
+          cd docs/
+          sphinx-build -M html source build
+      - name: Run ghp-import
+        run: |
+          ghp-import -n -p -f docs/build/html

pystran-0.0.1/.gitignore

@@ -0,0 +1,172 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+.vscode/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# pdoc
+./html
+*.html
+search.js
+
+# sphinx
+*.rst

pystran-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Petr Krysl
+
+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.

pystran-0.0.1/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: pystran
+Version: 0.0.1
+Summary: Python Structural Analysis package
+Project-URL: Homepage, https://github.com/PetrKryslUCSD/pystran
+Project-URL: Issues, https://github.com/PetrKryslUCSD/pystran/issues
+Author-email: Petr Krysl <pkrysl@ucsd.edu>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+[![Documentation pages](https://img.shields.io/badge/documentation-blue)](https://petrkryslucsd.github.io/pystran)
+ 
+# pystran: Python for Structural Analysis
+
+A simple structural analysis tool in Python, for structures consisting of truss
+and beam members, springs, and rigid bodies, both in two dimensions and in three dimensions.
+
+
+![Alt pystran capabilities in graphic abstract](docs/splash.png)
+
+## News
+
+- 11/08/2025: Add publishing workflow.
+- 03/13/2025: Update documentation for the sphinx system.
+- 03/10/2025: Add rigid links and general springs.
+
+
+[Past news](#past-news)
+
+## Features & Limitations
+
+
+- The package analyzes two-dimensional and three-dimensional structures made up
+  of truss (axial) members and beams (possibly in combination), rigid links, and
+  general springs. Concentrated masses can be added at joints.
+- Linear statics and dynamics (free vibration) solvers are included.
+- Only elastic models can be solved.
+- For beams, only the Bernoulli-Euler model is implemented, so no shear
+  deformation is taken into account.
+- Only straight members are treated.
+- It is assumed that the cross sections are doubly symmetric, and there is no coupling between the bending actions in the
+  two orthogonal principal planes.
+- Coupling of axial and bending action is not implemented. This means that the
+  neutral axis must pass through the centroid.
+- Warping of the cross sections is not modelled, hence only free torsion
+  effects are included.
+- Member loading is not considered. All member loading needs to be converted to
+  nodal forces by the user.
+- Member end releases (hinges)
+  are not implemented. Internal hinges can be modelled with linked joints. 
+- Degrees of freedom are only along the global Cartesian axes. Skew supports
+  are not included (except with a penalty method based on springs)
+- Offsets of the beams from the joints are currently not implemented.
+- Rigid links between pairs of joints can be modeled with a penalty approach.
+
+
+## Requirements
+
+`pystran` depends on the following Python packages: 
+- NumPy
+- SciPy
+- Matplotlib
+
+These requirements can be easily satisfied by running the examples in the [Spyder IDE](docs/spyder/spyder.md).
+
+## Documentation
+
+Documentation of the package is provided in these [HTML pages](https://petrkryslucsd.github.io/pystran).
+
+More details about the generation of the documentation are [here](docs/make_docs.md).
+
+## Running
+
+This package is not distributed through the official Python channels.
+It needs to be downloaded from GitHub as a zip file, and expanded in some convenient location. 
+
+The __`pystran` folder__ can be located by looking for this README.md file.
+
+The easiest way to run a pystran example is to download and install Spyder 6.
+[Detailed instructions](docs/spyder/spyder.md) are provided. 
+
+It is also possible to run simulations using a [plain Python in a terminal](docs/terminal/terminal.md).
+
+
+## Tutorials
+
+Step-by-step tutorials are available in the [`tutorials`](./tutorials) folder. 
+For example, run tutorials in the `pystran/tutorials` in the terminal  as 
+```
+py tutorials/01_three_bars_tut.py
+```
+
+Or, [use Spyder](docs/spyder/spyder.md), which makes the whole process a lot easier to set up.
+
+
+## Testing
+
+In the `pystran/tests` folder, run 
+```
+py unittests_planar_truss.py 
+```
+and analogously for the other unit test files.
+
+## <a name="past-news"></a>Past news
+
+- 03/05/2025: Describe the operation of the scripts.
+- 02/12/2025: Make it possible to use general joint and member identifiers.
+- 02/05/2025: Add general springs to ground.
+- 01/30/2025: Add tutorials.
+- 01/22/2025: Implement initial functionality. 

pystran-0.0.1/README.md

@@ -0,0 +1,101 @@
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active)
+[![Documentation pages](https://img.shields.io/badge/documentation-blue)](https://petrkryslucsd.github.io/pystran)
+ 
+# pystran: Python for Structural Analysis
+
+A simple structural analysis tool in Python, for structures consisting of truss
+and beam members, springs, and rigid bodies, both in two dimensions and in three dimensions.
+
+
+![Alt pystran capabilities in graphic abstract](docs/splash.png)
+
+## News
+
+- 11/08/2025: Add publishing workflow.
+- 03/13/2025: Update documentation for the sphinx system.
+- 03/10/2025: Add rigid links and general springs.
+
+
+[Past news](#past-news)
+
+## Features & Limitations
+
+
+- The package analyzes two-dimensional and three-dimensional structures made up
+  of truss (axial) members and beams (possibly in combination), rigid links, and
+  general springs. Concentrated masses can be added at joints.
+- Linear statics and dynamics (free vibration) solvers are included.
+- Only elastic models can be solved.
+- For beams, only the Bernoulli-Euler model is implemented, so no shear
+  deformation is taken into account.
+- Only straight members are treated.
+- It is assumed that the cross sections are doubly symmetric, and there is no coupling between the bending actions in the
+  two orthogonal principal planes.
+- Coupling of axial and bending action is not implemented. This means that the
+  neutral axis must pass through the centroid.
+- Warping of the cross sections is not modelled, hence only free torsion
+  effects are included.
+- Member loading is not considered. All member loading needs to be converted to
+  nodal forces by the user.
+- Member end releases (hinges)
+  are not implemented. Internal hinges can be modelled with linked joints. 
+- Degrees of freedom are only along the global Cartesian axes. Skew supports
+  are not included (except with a penalty method based on springs)
+- Offsets of the beams from the joints are currently not implemented.
+- Rigid links between pairs of joints can be modeled with a penalty approach.
+
+
+## Requirements
+
+`pystran` depends on the following Python packages: 
+- NumPy
+- SciPy
+- Matplotlib
+
+These requirements can be easily satisfied by running the examples in the [Spyder IDE](docs/spyder/spyder.md).
+
+## Documentation
+
+Documentation of the package is provided in these [HTML pages](https://petrkryslucsd.github.io/pystran).
+
+More details about the generation of the documentation are [here](docs/make_docs.md).
+
+## Running
+
+This package is not distributed through the official Python channels.
+It needs to be downloaded from GitHub as a zip file, and expanded in some convenient location. 
+
+The __`pystran` folder__ can be located by looking for this README.md file.
+
+The easiest way to run a pystran example is to download and install Spyder 6.
+[Detailed instructions](docs/spyder/spyder.md) are provided. 
+
+It is also possible to run simulations using a [plain Python in a terminal](docs/terminal/terminal.md).
+
+
+## Tutorials
+
+Step-by-step tutorials are available in the [`tutorials`](./tutorials) folder. 
+For example, run tutorials in the `pystran/tutorials` in the terminal  as 
+```
+py tutorials/01_three_bars_tut.py
+```
+
+Or, [use Spyder](docs/spyder/spyder.md), which makes the whole process a lot easier to set up.
+
+
+## Testing
+
+In the `pystran/tests` folder, run 
+```
+py unittests_planar_truss.py 
+```
+and analogously for the other unit test files.
+
+## <a name="past-news"></a>Past news
+
+- 03/05/2025: Describe the operation of the scripts.
+- 02/12/2025: Make it possible to use general joint and member identifiers.
+- 02/05/2025: Add general springs to ground.
+- 01/30/2025: Add tutorials.
+- 01/22/2025: Implement initial functionality.