particle_system_simulator

A structural model that lumps the masses in particle nodes and connects these with spring-dampers, to efficiently calculate internal forces, build for line systems and fabric/cloth materials.

https://github.com/awegroup/particle_system_simulator

Science Score: 65.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization awegroup has institutional domain (kitepower.tudelft.nl)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (17.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

A structural model that lumps the masses in particle nodes and connects these with spring-dampers, to efficiently calculate internal forces, build for line systems and fabric/cloth materials.

Basic Info
  • Host: GitHub
  • Owner: awegroup
  • License: mit
  • Language: HTML
  • Default Branch: main
  • Homepage:
  • Size: 55.9 MB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 3
  • Open Issues: 20
  • Releases: 1
Created about 3 years ago · Last pushed 11 months ago
Metadata Files
Readme License Citation

README.md

Particle System Simulator

Python package testing nicegif

This repository features tools for analyzing the deformation of line systems and membranes using a particle system model. It has been successfully used to model soft-wing kites and solar sails.

Installation Instructions

  1. Clone the repository: bash git clone https://github.com/awegroup/Particle_System_Simulator

  2. Navigate to the repository folder: bash cd Particle_System_Simulator

  3. Create a virtual environment:

Linux or Mac: bash python3 -m venv venv

Windows:
```bash
python -m venv venv
```
  1. Activate the virtual environment:

Linux or Mac: bash source venv/bin/activate

Windows
```bash
.\venv\Scripts\activate
```
  1. Install the required dependencies:

For users: bash pip install .

For developers: bash pip install -e .[dev]

  1. To deactivate the virtual environment: bash deactivate

Dependencies

  • numpy
  • pandas
  • matplotlib
  • scipy
  • sympy
  • dill
  • attrs

Usages

Navigate to the examples directory and run the desired script: bash cd examples python tutorial_1.py

Contributing Guide

We welcome contributions to this project! Whether you're reporting a bug, suggesting a feature, or writing code, here’s how you can contribute:

  1. Create an issue on GitHub
  2. Create a branch from this issue bash git checkout -b issue_number-new-feature
  3. --- Implement your new feature---
  4. Verify nothing broke using pytest pytest
  5. Commit your changes with a descriptive message git commit -m "#<number> <message>"
  6. Push your changes to the github repo: git push origin branch-name

  7. Create a pull-request, with base:develop, to merge this feature branch

  8. Once the pull request has been accepted, close the issue

Citation

If you use this project in your research, please consider citing it. Citation details can be found in the CITATION.cff file included in this repository.

More details can be found in: - Poland, J. A. W., & Schmehl, R. (2023). Modelling Aero-Structural Deformation of Flexible Membrane Kites. Energies, 16(14), 5264. https://doi.org/10.3390/en16145264 - MSc Thesis -by Alexander Batchelor- "Development and benchmarking of a Particle System framework for structural modeling of soft-wing kites"

License

This project is licensed under the MIT License - see the LICENSE file for details.

WAIVER

Technische Universiteit Delft hereby disclaims all copyright interest in the package written by the Author(s). Prof.dr. H.G.C. (Henri) Werij, Dean of Aerospace Engineering

Copyright

Copyright (c) 2024 J.A.W. Poland

Copyright (c) 2023 M. Kalsbeek

Copyright (c) 2023 A. Batchelor

Owner

  • Name: Airborne Wind Energy Research Group
  • Login: awegroup
  • Kind: organization
  • Email: r.schmehl@tudelft.nl
  • Location: Delft

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as shown below."
title: "Particle System Simulator: Design and Simulation Tool"
version: "1.0.0"
date-released: "2025-02-27"
keywords:
  - Particle System Model
  - Structural Model
  - Soft-Wing Kites
  - Lightsail Simulation
license: MIT
url: "https://github.com/awegroup/Particle_System_Simulator"
authors:
  - family-names: "Poland"
    given-names: "Jelle Agatho Wilhelm"
  - family-names: "Batchelor"
    given-names: "Alexander"
  - family-names: "Kalfsbeek"
    given-names: "Mark"
preferred-citation:
  type: article
  title: "Modelling Aero-Structural Deformation of Flexible Membrane Kites"
  authors:
    - family-names: "Poland"
      given-names: "Jelle Agatho Wilhelm"
    - family-names: "Schmehl"
      given-names: "Roland"
  journal: "Energies"
  volume: "16"
  article-number: "5264"
  year: "2023"
  doi: "10.3390/en16145264"
  note: "Also consider citing Batchelor's Master's thesis (2023): 'Development and Benchmarking of a Particle System Framework for Structural Modeling of Soft-Wing Kites' (Delft University of Technology, http://resolver.tudelft.nl/uuid:42bd7d60-de62-4e11-ad73-5468144aaf59)."

GitHub Events

Total
  • Issues event: 11
  • Delete event: 1
  • Issue comment event: 3
  • Member event: 1
  • Push event: 25
  • Pull request event: 5
  • Create event: 3
Last Year
  • Issues event: 11
  • Delete event: 1
  • Issue comment event: 3
  • Member event: 1
  • Push event: 25
  • Pull request event: 5
  • Create event: 3

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 9
  • Total pull requests: 4
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 months
  • Total issue authors: 3
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 8
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 6 minutes
  • Issue authors: 3
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jellepoland (12)
  • PatrickRoel (2)
  • nathanvdv98 (1)
  • mwakok (1)
Pull Request Authors
  • jellepoland (3)
  • Markk116 (3)
  • mwakok (2)
  • PatrickRoel (1)
  • edvinskis (1)
Top Labels
Issue Labels
enhancement (1) bug (1)
Pull Request Labels

Dependencies

.github/workflows/docs.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • peaceiris/actions-gh-pages v4 composite
.github/workflows/tests.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • orgoro/coverage v3.1 composite
pyproject.toml pypi