Particle System Simulator

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:

   git clone https://github.com/awegroup/Particle_System_Simulator

2. Navigate to the repository folder:

   cd Particle_System_Simulator

3. Create a virtual environment:

   Linux or Mac:

   python3 -m venv venv

   Windows:

   python -m venv venv

4. Activate the virtual environment:

   Linux or Mac:

   source venv/bin/activate

   Windows

   .\venv\Scripts\activate

5. Install the required dependencies:

   For users:

   pip install .

   For developers:

   pip install -e .[dev]

6. To deactivate the virtual environment:

   deactivate

Dependencies

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

Usages

Navigate to the examples directory and run the desired script:

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

   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