# springable
[](https://pypi.org/project/springable/)
[](https://colab.research.google.com/github/ducarme/springable/blob/main/docs/examples/example01_getting_started/example01_getting_started.ipynb)
[](https://overvelde.com/)
[-ece4fc)](https://amolf.nl/)
The Python package `springable` allows you to simulate how structures made out of springs deform when subject to forces.
By accounting for any geometrical changes (as large as they may be), the simulation allows you to explore the richness
of nonlinear mechanics, beyond the (boring) linear regime.
The implementation of the package is geared towards understanding how spring assemblies lead to mechanical behaviors
ranging from simple monotonic responses to complex, highly-nonlinear ones, such as snapping instabilities, sequencing,
buckling, symmetry-breaking or restabilization.
In its core, `springable` deals with **springs**, that we define as any entity that can store [elastic energy](https://en.wikipedia.org/wiki/Elastic_energy).
**Springs** therefore include longitudinal springs (compression and extension),
rotation springs (bending), area springs (useful to model fluids and pneumatic loading), line springs (useful to model cable-driven systems), and more!
**Table of contents**
- [Installation](#installation)
- [Don't want to install it right now? Try the Online Notebook](#dont-want-to-install-it-right-now-try-the-online-notebook)
- [How to use](#how-to-use)
* [Running a simulation](#running-a-simulation)
* [Creating a CSV file describing the spring model](#creating-a-csv-file-describing-the-spring-model)
+ [The `PARAMETERS` section](#the-parameters-section)
+ [The `NODES` section](#the-nodes-section)
+ [The `SPRINGS` section](#the-springs-section)
+ [The `ROTATION SPRINGS` section](#the-rotation-springs-section)
+ [The `AREA SPRINGS` section](#the-area-springs-section)
+ [The `LINE SPRINGS` section](#the-line-springs-section)
+ [The `LOADING` section](#the-loading-section)
+ [A complete example](#a-complete-example)
+ [Additional notes](#additional-notes)
* [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)
* [Configuring simulation settings](#configuring-simulation-settings)
+ [Additional notes](#additional-notes-1)
* [Advanced topics](#advanced-topics)
+ [Area spring with holes](#area-spring-with-holes)
+ [Complex loading descriptions](#complex-loading-descriptions)
+ [Scanning parameters](#scanning-parameters)
- [How to define your own custom springs](#how-to-define-your-own-custom-springs)
## Installation
Use `pip` to install. In the terminal simply enter
python -m pip install springable
and you are good to go!
It is supported on **Python 3.10 and above**.
## Don't want to install it right now? Try the Online Notebook
Try `springable` online, without any installation in an [interactive online notebook](https://colab.research.google.com/github/ducarme/springable/blob/main/docs/examples/example01_getting_started/example01_getting_started.ipynb)
## How to use
### Running a simulation
To start a simulation, we first create the file
that will describe the spring model we want to simulate. To do that, we create a simple
[CSV file](https://en.wikipedia.org/wiki/Comma-separated_values),
(a text file saved with extension *.csv*), that looks like this for example:
```csv
# my_spring_model.csv
PARAMETERS
stiffness, 1.0
NODES
0, 0.0, 0.0, 1, 1
1, 1.0, 0.0, 0, 1
SPRINGS
0-1, stiffness
LOADING
1, X, 2.0
```
This file defines a spring structure composed of only one horizontal spring, clamped on the left and loaded in tension from the right.
How to read or make such a file is described in the paragraph [Creating a CSV file describing the spring model](#creating-a-csv-file-describing-the-spring-model).
Many CSV file examples that describe spring structures are already available
[here on GitHub](https://github.com/ducarme/springable/tree/main/examples-spring-model-CSV-files) for inspiration or to download.
Next, we create a Python script (a text file saved with the extension *.py*), with the following content
```python
"""
Python script 'my_first_simulation.py'
Example to learn how to use the package springable
"""
import springable.simulation as ss
ss.simulate_model(model_path='my_spring_model.csv', save_dir='my_simulation_result')
```
and save it under the name - let's say - `my_first_spring_simulation.py`
The function `ss.simulate_model()` takes in two arguments:
* The `model_path` argument is the path leading to the [CSV file](https://en.wikipedia.org/wiki/Comma-separated_values)
that describes the model you want to simulate. In this case, we used the CSV file `my_spring_model.csv` that we have just created.
* The `save_dir` argument is simply the name of the folder under which the simulation results will be saved. It should not exist yet; it will be created automatically when we run the script.
It is an optional argument, if not specified, a folder will be created automatically in the working directory to store the result files.
Finally, we run the Python script. This can be done in the terminal by simply executing
python my_first_spring_simulation.py
>[!TIP]
> Many settings can be tuned before running a simulation. See paragraph [Configuring simulation settings](#configuring-simulation-settings) for more details.
### Creating a CSV file describing the spring model
The CSV file describing a valid spring model is specified as follows:
~~~~
PARAMETERS
<parameter name>, <parameter value>, [range]
<parameter name>, <parameter value>, [range]
...
NODES
<node index>, <x>, <y>, <constrained x>, <constrained y>
<node index>, <x>, <y>, <constrained x>, <constrained y>
...
SPRINGS
<node index>-<node index>, <mechanical behavior>, [natural length]
<node index>-<node index>, <mechanical behavior>, [natural length]
...
ROTATION SPRINGS
<node index>-<node index>-<node index>, <mechanical behavior>, [natural angle]
<node index>-<node index>-<node index>, <mechanical behavior>, [natural angle]
...
AREA SPRINGS
<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural area]
<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural area]
...
LINE SPRINGS
<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural length]
<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural length]
...
DISTANCE SPRINGS
<node index>-<node index>-<node index>, <mechanical behavior>, [natural distance]
<node index>-<node index>-<node index>, <mechanical behavior>, [natural distance]
...
LOADING
<node index>, <direction>, <force>, [max displacement]
<node index>, <direction>, <force>, [max displacement]
...
~~~~
NB:
* `<...>`: required field
* `[...]`: optional field
#### The `PARAMETERS` section
The `PARAMETERS` section serves to define some parameters that can be used to in the next sections. To define a parameter, a line with the following structure is added to the section `PARAMETERS`:\
`<parameter name>, <parameter value>`.
* `<parameter name>` is the name of the parameter (character string **without** quotes).
* `<parameter value>` is the value of the parameter. It can be either a float or a string (**with** simple quotes)
* `[range]` (optional) is a vector of possible values the parameter can have. This field is used only when [scanning the parameter space](#scanning-parameters). The range can be specified in two different ways:
* either as a vector of n regularly-spaced values between two float. Syntax: `[low bound; high bound; n]`. Example: `radius, 2.1, [2.0; 5.0; 4]`.
* either as a list of possible values. Syntax: `{value1; value2; value3; ...}`. Example: `radius, 2.1, {1.0; 7.0; 8.0; 2.0}`.
Example:
```csv
PARAMETERS
width, 2.0
height, 1.0
stiffness, 7.3
```
>Three parameters - `width`, `height` and `stiffness` - are defined
> and set to values `2.0`, `1.0` and `7.3` respectively.
#### The `NODES` section
The `NODES` section serves to define the nodes composing the spring assembly, by specifying their index,
their coordinates and the fact they are constrained or not. To define a node, a line with the following structure is added to the section `NODES`:\
`<node index>, <x>, <y>, <constrained x>, <constrained y>`.
* `<node index>` is a positive integer (`0`, `1`, `2`, ...) representing the index of the node being defined. Two nodes cannot have the same index.
When nodes are defined, indices cannot be skipped (if there are four nodes in total, the indices must be `0`, `1`, `2` and `3`). The order in which the nodes are defined does not matter.
* `<x>` is the horizontal coordinate of the node (float).
* `<y>` is the vertical coordinate of the node (float).
* `<constrained x>` is either
* `1` if the node cannot move horizontally,
* `0` if the node is free to move horizontally.
* `<constrained y>` is either
* `1` if the node cannot move vertically,
* `0` if the node is free to move vertically.
Example:
```csv
NODES
0, -width/2, 0.0, 1, 1
1, +width/2, 0.0, 1, 1
2, 0.0, height, 1, 0
```
>Three nodes labelled `0`, `1` and `2` are defined at coordinates `(-width/2, 0.0)`, `(+width/2, 0.0)`, `(0.0, height)`
respectively. Nodes `0` and `1` are constrained horizontally and vertically, while node `2` is constrained horizontally
but free to move vertically.
#### The `SPRINGS` section
The `SPRINGS` section serves to define **longitudinal springs**, that is, springs whose elastic energy is a function of their length.
Each longitudinal spring is defined by the
**two nodes** it connects, a **mechanical behavior**, and optionally its **natural length**,
that is the length it has if not constrained nor loaded. If no natural length is provided, the natural length is
automatically set to the distance between the nodes connected by the spring.
The mechanical behavior describes its intrinsic axial force-displacement relation. It can be a linear behavior
(the spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one
(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).
To define a longitudinal spring, a line with the following structure is added to the section `SPRINGS`:\
`<node index>-<node index>, <mechanical behavior>, [natural length]`.
* `<node index>` is the index of one of the node connected to the spring.
* `<node index>` is the index of the other node connected to the spring.
* `<mechanical behavior>` is the axial mechanical behavior of the spring. To specify a **linear** longitudinal spring,
the mechanical behavior is simply the **spring constant** (positive float).
* `[natural length]` is the natural length of the spring connecting both nodes (positive float).
It is an optional parameter; if not provided the natural length of the spring element will automatically be set to the
distance between both nodes as created in the `NODES` section.
Example:
```csv
SPRINGS
0-2, stiffness
1-2, stiffness
```
>Two linear longitudinal springs are defined. Both are characterized by the spring constant value `stiffness`.
No natural length was provided, so their natural length will be automatically set to the distance between nodes `0`
and `2`, and between nodes `1` and `2` as defined in the section `NODES`, respectively.
#### The `ROTATION SPRINGS` section
The `ROTATION SPRINGS` section serves to define **rotation springs**
(also known as [torsion springs](https://en.wikipedia.org/wiki/Torsion_spring)), that is, springs whose elastic energy is a function of an angle. They are useful when modelling mechanical systems involving elastic bending, such as flexures for example.
Those springs are defined by specifying **three nodes** A, B and C,
which together, define the angle ABC (B is the vertex of the angle). More precisely, the angle ABC is the angle by which
the segment BA must rotate counterclockwise (about B) to align with segment BC. The angle is always between 0 and 2π.
Along with its three nodes, the **mechanical behavior** must be specified, and optionally the natural angle of the rotation
spring (in radians). If no natural angle is provided, the natural angle is automatically set to the angle defined by the
three specified nodes. The mechanical behavior describes its intrinsic (torque)-(angle-change) relation. It can be a linear behavior
(the rotation spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one
(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).
To define a rotation spring, a line with the following structure is added to the section `ROTATION SPRINGS`:\
`<node index>-<node index>-<node index>, <mechanical behavior>, [natural angle]`.
* `<node index>` is the index of node A.
* `<node index>` is the index of node B.
* `<node index>` is the index of node C.
* `<mechanical behavior>` is the angular mechanical behavior of the rotation spring. To specify a **linear** rotation spring,
the mechanical behavior is simply the **spring constant** (positive float), that is the slope of its (torque)-(angle-change) curve.
* `[natural angle]` is the natural angle of the rotation spring in radians (float in [0, 2π[).
It is an optional parameter; if not provided the natural angle of the rotation spring will automatically be set to the
angle defined by nodes A, B and C as created in the `NODES` section.
Example:
```csv
ROTATION SPRINGS
0-2-1, 1.5, PI/2
```
>A linear rotation spring is defined. The torque it creates will be determined by the difference between the angle 021
(vertex at node `2`) and its natural angle `PI/2` (90 deg). The angle-difference versus torque relation is defined
by the spring constant set to `1.5`.
Note that if no natural angle was specified, the natural angle would have been automatically set to the angle defined by
the nodes `0`, `1` and `2` as defined in the section `NODES`.
#### The `AREA SPRINGS` section
The `AREA SPRINGS` section serves to define **area springs**, that is, springs whose elastic energy is a function of their area. They are useful when modelling mechanical systems involving fluids and pneumatic or hydraulic components.
Those springs are defined by specifying **n nodes** (n>=3), which together define the area of a
[simple polygon](https://en.wikipedia.org/wiki/Simple_polygon). More precisely, the nodes are the vertices listed sequentially that form the single closed boundary of the polygon.
The sequence of nodes should *not* be ending with the starting node. The polygon can be convex or concave, but not self-intersecting. The boundary of the polygon can be specified by listing the vertices clockwise or counterclockwise.
Along with its n nodes, the **mechanical behavior** must be specified, and optionally the natural area of the area
spring. If no natural area is provided, the natural area is automatically set to the area defined by the
n specified nodes. The mechanical behavior describes its intrinsic (2d-pressure)-(area-change) relation. It can be a linear behavior
(the area spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one
(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).
To define an area spring, a line with the following structure is added to the section `AREA SPRINGS`:\
`<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural area]`.
* `<node index>` is the index of a first node that form the boundary of the polygon,
* `<node index>` is the index of the second node, following the first node along the boundary (clockwise or counter-clockwise),
* `<node index>` is the index of the third node following the second node along the boundary (clockwise or counter-clockwise),
* `<node index>` ... etc.
* `<mechanical behavior>` is the areal mechanical behavior of the area spring. To specify a **linear** area spring,
the mechanical behavior is simply the **spring constant** (positive float), that is the slope of its (2d-pressure)-(area-change) curve.
* `[natural area]` is the natural area of the area spring (float).
It is an optional parameter; if not provided the natural area of the area spring will automatically be set to the
area defined by the n nodes as created in the `NODES` section.
> [!NOTE]
> To define an area spring associated to a **[polygon with holes](https://en.wikipedia.org/wiki/Polygon_with_holes)**,
please refer to [Area springs with holes](#area-spring-with-holes) paragraph in the [Advanced topics](#advanced-topics).*
Example:
```csv
AREA SPRINGS
0-2-1, 3.0
```
>A linear area spring is defined. The 2d-pressure it creates will be determined by the difference between the area of the polygon 0210
and its natural area. The area-change versus 2d-pressure relation is defined
by the spring constant set to `3.0`.
Here, no natural area was provided, so the natural area will be automatically set to
the area of the polygon defined by the nodes `0`, `2`, and `1` as defined in the section `NODES`.
#### The `LINE SPRINGS` section
The `LINE SPRINGS` section serves to define **line springs**, that is, springs whose elastic energy is a function of their [polygonal chain](https://en.wikipedia.org/wiki/Polygonal_chain)'s length.
They are useful when modelling mechanical systems involving cable-driven actuation or [pulleys](https://en.wikipedia.org/wiki/Pulley).
Those springs are defined by specifying **n nodes** (n>=2), which together define a polygonal chain. More precisely, the nodes are the vertices listed sequentially that form the chain.
The sequence of nodes does not need to (but can) be closed (first and last node can be different or identical).
Along with its n nodes, the **mechanical behavior** must be specified, and optionally the natural length of the line
spring. If no natural length is provided, the natural length is automatically set to the length defined by the
n specified nodes. The mechanical behavior describes its intrinsic tension-displacement relation. It can be a linear behavior
(the line spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one
(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).
To define a line spring, a line with the following structure is added to the section `LINE SPRINGS`:\
`<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural length]`.
* `<node index>` is the index of a first node that form the polygonal chain,
* `<node index>` is the index of the second node, following the first node along the chain,
* `<node index>` is the index of the third node following the second node along the chain,
* `<node index>` ... etc.
* `<mechanical behavior>` is the mechanical behavior of the line spring. To specify a **linear** line spring,
the mechanical behavior is simply the **spring constant** (positive float), that is the slope of its tension-displacement curve.
* `[natural length]` is the natural length of the line spring (float).
It is an optional parameter; if not provided the natural length of the line spring will automatically be set to the
length defined by the n nodes as created in the `NODES` section.
Example:
```csv
LINE SPRINGS
0-2-1, 1.0
```
>A linear line spring is defined. The tension it creates will be determined by the difference between its current and natural lengths.
The displacement versus tension relation is defined by the spring constant set to `1.0`.
Here, no natural length was provided, so the natural length will be automatically set to
the length of the polygonal chain defined by the nodes `0`, `2`, and `1` as defined in the section `NODES`.
#### The `LOADING` section
The `LOADING` section serves to set the forces applied on some specific nodes along a specific direction (horizontal or vertical).
To define a horizontal or vertical force on a node, a line with the following structure is added to the section `LOADING`:\
`<node index>, <direction>, <force>, [max displacement]`.
* `<node index>` is the index of the node on which the force is applied.
* `<direction>` is either:
* `X` for a horizontal force,
* `Y` for a vertical force.
* `<force>` the signed amplitude of the force (negative or positive float)
* `[max displacement]` is the maximum displacement of the specified node along the specified direction (positive float).
Beyond this value, the simulation will finish (even if the force has not been reached yet).
It is an optional parameter; if not provided, there is no maximum displacement at which the simulation can finish
prematurely (it is the same as setting the maximum displacement to a value close to infinity).
Example:
```csv
LOADING
2, Y, -10.0, -3.0
```
>A force is applied on node `2`, along the `Y`-direction (vertical).
The magnitude of the force is `-10` (it is a negative value, so the force points downwards).
The maximum displacement is set to `-3.0`, meaning that if node `2` is displaced downward by more that `3.0`,
the simulation is assumed to have completed.
> [!NOTE]
> More complex loading can be specified (preloading, multiple loading steps, blocking nodes).
Please refer to [Complex loading descriptions](#complex-loading-descriptions) paragraph in the [Advanced topics](#advanced-topics) for more details.*
#### A complete example
This example describes a spring structure composed of two inclined linear longitudinal springs connected in the center,
and hinging through a linear rotation spring.
```csv
# spring model example (this is a comment)
PARAMETERS
width, 2.0
height, 1.0
stiffness, 7.3
NODES
0, -width/2, 0.0, 1, 1
1, +width/2, 0.0, 1, 1
2, 0.0, height, 1, 0
SPRINGS
0-2, stiffness
1-2, stiffness
ROTATION SPRINGS
0-2-1, 1.5, PI/2
LOADING
2, Y, -10.0, -3.0
```
#### Additional notes
* Empty lines have no semantic meaning. Adding/removing some will not change the spring model.
* `#` is used to indicate a line comment. Each line starting with `#` will be ignored when reading the file.
* Parameters can be combined in mathematical expression in all sections but `PARAMETERS`. Supported operations include
`(...)`, `+`, `-`, `*`, `/`, `SIN(...)` (sine), `COS(...)` (cosine), `TAN(...)` (tangent), `SQRT(...)` (square root).
Value π can be used without defining it in the section `PARAMETERS` with the keyword `PI`.
* If your spring assembly does not include a certain type of spring, feel free to leave the corresponding section empty (header only)
or to omit it completely (no header and no content).
### Specifying a nonlinear mechanical behavior
TO DO
### Configuring simulation settings
Many settings can be tuned before running a simulation. They fall into two categories: **solver settings**
or **graphics settings**.
Solver settings only affect the solver (that is the part responsible to solve the nonlinear equations,
by computing all the equilibrium points), while graphics settings determines what is generated to visualize a result
(previously computed by the solver), and how it is going to look like.
All default solver and graphics settings along with useful documentation are listed in the files
`default_solver_settings.toml` and `default_graphics_settings.toml` respectively. They are available
[here on GitHub](https://github.com/ducarme/springable).
When you wish to change a setting (let's say a solver setting),
create a [TOML file](https://toml.io/en/), that is a text file saved with extension *.toml*. You can use the NotePad (Windows)
or TextEdit (MacOS) to do that, for example. The file will look similar to this:
```toml
# custom_solver_settings.toml
radius = 0.01
reference_load_parameter = 0.01
```
*Low values for `radius` and `reference_load_parameter` can be used to refine the solution,
at the cost of increasing the solving duration. Default values are 0.05 and 0.05, respectively.*
To use these custom solver settings, use the path to `custom_solver_settings.toml`
as an extra argument of the `ss.simulate_model()` function, as follows:
```python
"""
my_first_simulation.py
Example to learn how to use the package springable
"""
import springable.simulation as ss
ss.simulate_model(model_path='my_spring_model.csv', save_dir='my_simulation_result',
solver_settings_path='custom_solver_settings.toml')
```
Similarly, when you wish to modify a graphics setting, create another TOML file and include the settings you wish to modify
```toml
# custom_graphics_settings.toml
[animation_options]
nb_frames = 240
fps = 60
[plot_options]
show_snapping_arrows = true
drive_mode = "force"
```
*Animation settings `nb_frames` and `fps` determine the number of frames and the frame rate (in frame per second) of the animation showing
the spring assembly deforming. Plot settings `show_snapping_arrows = true` combined with `drive_mode = "force"` means that
you want to indicate with arrows the (potential) snapping transitions under controlled force in the force-displacement plot.
To indicate, snapping transitions under controlled displacement use `show_snapping_arrows = true` combined with `drive_mode = "displacement"`
instead.*
To use these custom graphics settings, use the path to `custom_graphics_settings.toml`
as an extra argument of the `ss.simulate_model()` function, as follows:
```python
"""
my_first_simulation.py
Example to learn how to use the package springable
"""
import springable.simulation as ss
ss.simulate_model(model_path='my_spring_model.csv', save_dir='my_simulation_result',
solver_settings_path='custom_solver_settings.toml',
graphics_settings_path='custom_graphics_settings.toml')
```
#### Additional notes
* A custom settings file does not need to contain all the possible settings; just include the one you wish to modify.
* Graphics settings are divided into 4 sections of settings (indicated by `[...]` in TOML files):
* general options (determines _what_ should be generated and directly shown (drawing, animation, plot))
* plot options (determines _how_ plots will look like)
* animation options (determines _how_ animations will look like)
* assembly appearance (determines _how_ the spring assembly will be depicted)
### Advanced topics
#### Area spring with holes
#### Complex loading descriptions
#### Scanning parameters
## How to define your own custom springs
TO DO
Raw data
{
"_id": null,
"home_page": null,
"name": "springable",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "nonlinear, spring, simulation, animation, instability, snap-through",
"author": "Paul Ducarme",
"author_email": "paulducarme@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/b9/b8/2605b23189ace4e7e556c884e562d284902bab0425719e29fab1fc51f4e5/springable-0.1.0.tar.gz",
"platform": null,
"description": "# springable\r\n\r\n\r\n[](https://pypi.org/project/springable/)\r\n[](https://colab.research.google.com/github/ducarme/springable/blob/main/docs/examples/example01_getting_started/example01_getting_started.ipynb)\r\n[](https://overvelde.com/)\r\n[-ece4fc)](https://amolf.nl/)\r\n\r\n\r\n\r\n\r\nThe Python package `springable` allows you to simulate how structures made out of springs deform when subject to forces.\r\nBy accounting for any geometrical changes (as large as they may be), the simulation allows you to explore the richness\r\nof nonlinear mechanics, beyond the (boring) linear regime.\r\n\r\nThe implementation of the package is geared towards understanding how spring assemblies lead to mechanical behaviors\r\nranging from simple monotonic responses to complex, highly-nonlinear ones, such as snapping instabilities, sequencing,\r\nbuckling, symmetry-breaking or restabilization.\r\n\r\nIn its core, `springable` deals with **springs**, that we define as any entity that can store [elastic energy](https://en.wikipedia.org/wiki/Elastic_energy).\r\n**Springs** therefore include longitudinal springs (compression and extension),\r\nrotation springs (bending), area springs (useful to model fluids and pneumatic loading), line springs (useful to model cable-driven systems), and more!\r\n\r\n**Table of contents**\r\n\r\n\r\n- [Installation](#installation)\r\n- [Don't want to install it right now? Try the Online Notebook](#dont-want-to-install-it-right-now-try-the-online-notebook)\r\n- [How to use](#how-to-use)\r\n * [Running a simulation](#running-a-simulation)\r\n * [Creating a CSV file describing the spring model](#creating-a-csv-file-describing-the-spring-model)\r\n + [The `PARAMETERS` section](#the-parameters-section)\r\n + [The `NODES` section](#the-nodes-section)\r\n + [The `SPRINGS` section](#the-springs-section)\r\n + [The `ROTATION SPRINGS` section](#the-rotation-springs-section)\r\n + [The `AREA SPRINGS` section](#the-area-springs-section)\r\n + [The `LINE SPRINGS` section](#the-line-springs-section)\r\n + [The `LOADING` section](#the-loading-section)\r\n + [A complete example](#a-complete-example)\r\n + [Additional notes](#additional-notes)\r\n * [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)\r\n * [Configuring simulation settings](#configuring-simulation-settings)\r\n + [Additional notes](#additional-notes-1)\r\n * [Advanced topics](#advanced-topics)\r\n + [Area spring with holes](#area-spring-with-holes)\r\n + [Complex loading descriptions](#complex-loading-descriptions)\r\n + [Scanning parameters](#scanning-parameters)\r\n- [How to define your own custom springs](#how-to-define-your-own-custom-springs)\r\n\r\n## Installation\r\n\r\nUse `pip` to install. In the terminal simply enter\r\n\r\n python -m pip install springable\r\n\r\nand you are good to go!\r\n\r\nIt is supported on **Python 3.10 and above**.\r\n\r\n## Don't want to install it right now? Try the Online Notebook\r\nTry `springable` online, without any installation in an [interactive online notebook](https://colab.research.google.com/github/ducarme/springable/blob/main/docs/examples/example01_getting_started/example01_getting_started.ipynb)\r\n\r\n\r\n## How to use\r\n\r\n### Running a simulation\r\nTo start a simulation, we first create the file \r\nthat will describe the spring model we want to simulate. To do that, we create a simple\r\n[CSV file](https://en.wikipedia.org/wiki/Comma-separated_values),\r\n(a text file saved with extension *.csv*), that looks like this for example:\r\n```csv\r\n# my_spring_model.csv\r\n\r\nPARAMETERS\r\nstiffness, 1.0\r\nNODES\r\n0, 0.0, 0.0, 1, 1\r\n1, 1.0, 0.0, 0, 1\r\nSPRINGS\r\n0-1, stiffness\r\nLOADING\r\n1, X, 2.0\r\n```\r\nThis file defines a spring structure composed of only one horizontal spring, clamped on the left and loaded in tension from the right.\r\n\r\nHow to read or make such a file is described in the paragraph [Creating a CSV file describing the spring model](#creating-a-csv-file-describing-the-spring-model).\r\nMany CSV file examples that describe spring structures are already available\r\n[here on GitHub](https://github.com/ducarme/springable/tree/main/examples-spring-model-CSV-files) for inspiration or to download.\r\n\r\nNext, we create a Python script (a text file saved with the extension *.py*), with the following content\r\n\r\n```python\r\n\"\"\"\r\nPython script 'my_first_simulation.py'\r\nExample to learn how to use the package springable\r\n\"\"\"\r\nimport springable.simulation as ss\r\n\r\nss.simulate_model(model_path='my_spring_model.csv', save_dir='my_simulation_result')\r\n```\r\nand save it under the name - let's say - `my_first_spring_simulation.py`\r\n\r\nThe function `ss.simulate_model()` takes in two arguments:\r\n* The `model_path` argument is the path leading to the [CSV file](https://en.wikipedia.org/wiki/Comma-separated_values)\r\nthat describes the model you want to simulate. In this case, we used the CSV file `my_spring_model.csv` that we have just created.\r\n* The `save_dir` argument is simply the name of the folder under which the simulation results will be saved. It should not exist yet; it will be created automatically when we run the script.\r\nIt is an optional argument, if not specified, a folder will be created automatically in the working directory to store the result files.\r\n\r\nFinally, we run the Python script. This can be done in the terminal by simply executing\r\n\r\n python my_first_spring_simulation.py\r\n\r\n\r\n\r\n\r\n>[!TIP]\r\n> Many settings can be tuned before running a simulation. See paragraph [Configuring simulation settings](#configuring-simulation-settings) for more details.\r\n\r\n### Creating a CSV file describing the spring model\r\n\r\n\r\nThe CSV file describing a valid spring model is specified as follows:\r\n\r\n~~~~\r\nPARAMETERS\r\n<parameter name>, <parameter value>, [range]\r\n<parameter name>, <parameter value>, [range]\r\n...\r\nNODES\r\n<node index>, <x>, <y>, <constrained x>, <constrained y>\r\n<node index>, <x>, <y>, <constrained x>, <constrained y>\r\n...\r\nSPRINGS\r\n<node index>-<node index>, <mechanical behavior>, [natural length]\r\n<node index>-<node index>, <mechanical behavior>, [natural length]\r\n...\r\nROTATION SPRINGS\r\n<node index>-<node index>-<node index>, <mechanical behavior>, [natural angle]\r\n<node index>-<node index>-<node index>, <mechanical behavior>, [natural angle]\r\n...\r\nAREA SPRINGS\r\n<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural area]\r\n<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural area]\r\n...\r\nLINE SPRINGS\r\n<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural length]\r\n<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural length]\r\n...\r\nDISTANCE SPRINGS\r\n<node index>-<node index>-<node index>, <mechanical behavior>, [natural distance]\r\n<node index>-<node index>-<node index>, <mechanical behavior>, [natural distance]\r\n...\r\nLOADING\r\n<node index>, <direction>, <force>, [max displacement]\r\n<node index>, <direction>, <force>, [max displacement]\r\n...\r\n~~~~\r\nNB:\r\n* `<...>`: required field\r\n* `[...]`: optional field\r\n\r\n\r\n#### The `PARAMETERS` section\r\nThe `PARAMETERS` section serves to define some parameters that can be used to in the next sections. To define a parameter, a line with the following structure is added to the section `PARAMETERS`:\\\r\n`<parameter name>, <parameter value>`.\r\n* `<parameter name>` is the name of the parameter (character string **without** quotes).\r\n* `<parameter value>` is the value of the parameter. It can be either a float or a string (**with** simple quotes)\r\n* `[range]` (optional) is a vector of possible values the parameter can have. This field is used only when [scanning the parameter space](#scanning-parameters). The range can be specified in two different ways:\r\n * either as a vector of n regularly-spaced values between two float. Syntax: `[low bound; high bound; n]`. Example: `radius, 2.1, [2.0; 5.0; 4]`.\r\n * either as a list of possible values. Syntax: `{value1; value2; value3; ...}`. Example: `radius, 2.1, {1.0; 7.0; 8.0; 2.0}`.\r\n\r\nExample:\r\n```csv\r\nPARAMETERS\r\nwidth, 2.0\r\nheight, 1.0\r\nstiffness, 7.3\r\n```\r\n>Three parameters - `width`, `height` and `stiffness` - are defined\r\n> and set to values `2.0`, `1.0` and `7.3` respectively.\r\n\r\n#### The `NODES` section\r\nThe `NODES` section serves to define the nodes composing the spring assembly, by specifying their index,\r\ntheir coordinates and the fact they are constrained or not. To define a node, a line with the following structure is added to the section `NODES`:\\\r\n`<node index>, <x>, <y>, <constrained x>, <constrained y>`.\r\n* `<node index>` is a positive integer (`0`, `1`, `2`, ...) representing the index of the node being defined. Two nodes cannot have the same index.\r\nWhen nodes are defined, indices cannot be skipped (if there are four nodes in total, the indices must be `0`, `1`, `2` and `3`). The order in which the nodes are defined does not matter.\r\n* `<x>` is the horizontal coordinate of the node (float).\r\n* `<y>` is the vertical coordinate of the node (float).\r\n* `<constrained x>` is either\r\n * `1` if the node cannot move horizontally,\r\n * `0` if the node is free to move horizontally.\r\n* `<constrained y>` is either\r\n * `1` if the node cannot move vertically,\r\n * `0` if the node is free to move vertically.\r\n\r\nExample:\r\n```csv\r\nNODES\r\n0, -width/2, 0.0, 1, 1\r\n1, +width/2, 0.0, 1, 1\r\n2, 0.0, height, 1, 0\r\n```\r\n>Three nodes labelled `0`, `1` and `2` are defined at coordinates `(-width/2, 0.0)`, `(+width/2, 0.0)`, `(0.0, height)`\r\nrespectively. Nodes `0` and `1` are constrained horizontally and vertically, while node `2` is constrained horizontally\r\nbut free to move vertically.\r\n\r\n#### The `SPRINGS` section\r\nThe `SPRINGS` section serves to define **longitudinal springs**, that is, springs whose elastic energy is a function of their length.\r\nEach longitudinal spring is defined by the\r\n**two nodes** it connects, a **mechanical behavior**, and optionally its **natural length**,\r\nthat is the length it has if not constrained nor loaded. If no natural length is provided, the natural length is\r\nautomatically set to the distance between the nodes connected by the spring.\r\n\r\nThe mechanical behavior describes its intrinsic axial force-displacement relation. It can be a linear behavior\r\n(the spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one\r\n(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).\r\n\r\nTo define a longitudinal spring, a line with the following structure is added to the section `SPRINGS`:\\\r\n`<node index>-<node index>, <mechanical behavior>, [natural length]`.\r\n* `<node index>` is the index of one of the node connected to the spring.\r\n* `<node index>` is the index of the other node connected to the spring.\r\n* `<mechanical behavior>` is the axial mechanical behavior of the spring. To specify a **linear** longitudinal spring,\r\nthe mechanical behavior is simply the **spring constant** (positive float).\r\n* `[natural length]` is the natural length of the spring connecting both nodes (positive float). \r\nIt is an optional parameter; if not provided the natural length of the spring element will automatically be set to the\r\ndistance between both nodes as created in the `NODES` section.\r\n\r\nExample:\r\n```csv\r\nSPRINGS\r\n0-2, stiffness\r\n1-2, stiffness\r\n```\r\n>Two linear longitudinal springs are defined. Both are characterized by the spring constant value `stiffness`.\r\nNo natural length was provided, so their natural length will be automatically set to the distance between nodes `0`\r\nand `2`, and between nodes `1` and `2` as defined in the section `NODES`, respectively.\r\n\r\n#### The `ROTATION SPRINGS` section\r\nThe `ROTATION SPRINGS` section serves to define **rotation springs**\r\n(also known as [torsion springs](https://en.wikipedia.org/wiki/Torsion_spring)), that is, springs whose elastic energy is a function of an angle. They are useful when modelling mechanical systems involving elastic bending, such as flexures for example.\r\nThose springs are defined by specifying **three nodes** A, B and C,\r\nwhich together, define the angle ABC (B is the vertex of the angle). More precisely, the angle ABC is the angle by which\r\nthe segment BA must rotate counterclockwise (about B) to align with segment BC. The angle is always between 0 and 2\u03c0.\r\n\r\nAlong with its three nodes, the **mechanical behavior** must be specified, and optionally the natural angle of the rotation\r\nspring (in radians). If no natural angle is provided, the natural angle is automatically set to the angle defined by the\r\nthree specified nodes. The mechanical behavior describes its intrinsic (torque)-(angle-change) relation. It can be a linear behavior\r\n(the rotation spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one\r\n(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).\r\n\r\nTo define a rotation spring, a line with the following structure is added to the section `ROTATION SPRINGS`:\\\r\n`<node index>-<node index>-<node index>, <mechanical behavior>, [natural angle]`.\r\n* `<node index>` is the index of node A.\r\n* `<node index>` is the index of node B.\r\n* `<node index>` is the index of node C.\r\n* `<mechanical behavior>` is the angular mechanical behavior of the rotation spring. To specify a **linear** rotation spring,\r\nthe mechanical behavior is simply the **spring constant** (positive float), that is the slope of its (torque)-(angle-change) curve.\r\n* `[natural angle]` is the natural angle of the rotation spring in radians (float in [0, 2\u03c0[). \r\nIt is an optional parameter; if not provided the natural angle of the rotation spring will automatically be set to the\r\nangle defined by nodes A, B and C as created in the `NODES` section.\r\n\r\nExample:\r\n```csv\r\nROTATION SPRINGS\r\n0-2-1, 1.5, PI/2\r\n```\r\n>A linear rotation spring is defined. The torque it creates will be determined by the difference between the angle 021\r\n(vertex at node `2`) and its natural angle `PI/2` (90 deg). The angle-difference versus torque relation is defined\r\nby the spring constant set to `1.5`.\r\nNote that if no natural angle was specified, the natural angle would have been automatically set to the angle defined by\r\nthe nodes `0`, `1` and `2` as defined in the section `NODES`.\r\n\r\n\r\n#### The `AREA SPRINGS` section\r\nThe `AREA SPRINGS` section serves to define **area springs**, that is, springs whose elastic energy is a function of their area. They are useful when modelling mechanical systems involving fluids and pneumatic or hydraulic components.\r\nThose springs are defined by specifying **n nodes** (n>=3), which together define the area of a\r\n[simple polygon](https://en.wikipedia.org/wiki/Simple_polygon). More precisely, the nodes are the vertices listed sequentially that form the single closed boundary of the polygon.\r\nThe sequence of nodes should *not* be ending with the starting node. The polygon can be convex or concave, but not self-intersecting. The boundary of the polygon can be specified by listing the vertices clockwise or counterclockwise.\r\n\r\nAlong with its n nodes, the **mechanical behavior** must be specified, and optionally the natural area of the area\r\nspring. If no natural area is provided, the natural area is automatically set to the area defined by the\r\nn specified nodes. The mechanical behavior describes its intrinsic (2d-pressure)-(area-change) relation. It can be a linear behavior\r\n(the area spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one\r\n(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).\r\n\r\nTo define an area spring, a line with the following structure is added to the section `AREA SPRINGS`:\\\r\n`<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural area]`.\r\n* `<node index>` is the index of a first node that form the boundary of the polygon,\r\n* `<node index>` is the index of the second node, following the first node along the boundary (clockwise or counter-clockwise),\r\n* `<node index>` is the index of the third node following the second node along the boundary (clockwise or counter-clockwise),\r\n* `<node index>` ... etc.\r\n* `<mechanical behavior>` is the areal mechanical behavior of the area spring. To specify a **linear** area spring,\r\nthe mechanical behavior is simply the **spring constant** (positive float), that is the slope of its (2d-pressure)-(area-change) curve.\r\n* `[natural area]` is the natural area of the area spring (float). \r\nIt is an optional parameter; if not provided the natural area of the area spring will automatically be set to the\r\narea defined by the n nodes as created in the `NODES` section.\r\n\r\n> [!NOTE]\r\n> To define an area spring associated to a **[polygon with holes](https://en.wikipedia.org/wiki/Polygon_with_holes)**,\r\nplease refer to [Area springs with holes](#area-spring-with-holes) paragraph in the [Advanced topics](#advanced-topics).*\r\n\r\nExample:\r\n```csv\r\nAREA SPRINGS\r\n0-2-1, 3.0\r\n```\r\n>A linear area spring is defined. The 2d-pressure it creates will be determined by the difference between the area of the polygon 0210\r\nand its natural area. The area-change versus 2d-pressure relation is defined\r\nby the spring constant set to `3.0`.\r\nHere, no natural area was provided, so the natural area will be automatically set to\r\nthe area of the polygon defined by the nodes `0`, `2`, and `1` as defined in the section `NODES`.\r\n\r\n#### The `LINE SPRINGS` section\r\nThe `LINE SPRINGS` section serves to define **line springs**, that is, springs whose elastic energy is a function of their [polygonal chain](https://en.wikipedia.org/wiki/Polygonal_chain)'s length.\r\nThey are useful when modelling mechanical systems involving cable-driven actuation or [pulleys](https://en.wikipedia.org/wiki/Pulley).\r\nThose springs are defined by specifying **n nodes** (n>=2), which together define a polygonal chain. More precisely, the nodes are the vertices listed sequentially that form the chain.\r\nThe sequence of nodes does not need to (but can) be closed (first and last node can be different or identical).\r\n\r\nAlong with its n nodes, the **mechanical behavior** must be specified, and optionally the natural length of the line\r\nspring. If no natural length is provided, the natural length is automatically set to the length defined by the\r\nn specified nodes. The mechanical behavior describes its intrinsic tension-displacement relation. It can be a linear behavior\r\n(the line spring follows [Hooke's law](https://en.wikipedia.org/wiki/Hooke%27s_law)) or a nonlinear one\r\n(see section [Specifying a nonlinear mechanical behavior](#specifying-a-nonlinear-mechanical-behavior)).\r\n\r\nTo define a line spring, a line with the following structure is added to the section `LINE SPRINGS`:\\\r\n`<node index>-<node index>-<node index>-..., <mechanical behavior>, [natural length]`.\r\n* `<node index>` is the index of a first node that form the polygonal chain,\r\n* `<node index>` is the index of the second node, following the first node along the chain,\r\n* `<node index>` is the index of the third node following the second node along the chain,\r\n* `<node index>` ... etc.\r\n* `<mechanical behavior>` is the mechanical behavior of the line spring. To specify a **linear** line spring,\r\nthe mechanical behavior is simply the **spring constant** (positive float), that is the slope of its tension-displacement curve.\r\n* `[natural length]` is the natural length of the line spring (float). \r\nIt is an optional parameter; if not provided the natural length of the line spring will automatically be set to the\r\nlength defined by the n nodes as created in the `NODES` section.\r\n\r\n\r\nExample:\r\n```csv\r\nLINE SPRINGS\r\n0-2-1, 1.0\r\n```\r\n>A linear line spring is defined. The tension it creates will be determined by the difference between its current and natural lengths.\r\nThe displacement versus tension relation is defined by the spring constant set to `1.0`.\r\nHere, no natural length was provided, so the natural length will be automatically set to\r\nthe length of the polygonal chain defined by the nodes `0`, `2`, and `1` as defined in the section `NODES`.\r\n\r\n\r\n#### The `LOADING` section\r\nThe `LOADING` section serves to set the forces applied on some specific nodes along a specific direction (horizontal or vertical).\r\nTo define a horizontal or vertical force on a node, a line with the following structure is added to the section `LOADING`:\\\r\n`<node index>, <direction>, <force>, [max displacement]`.\r\n* `<node index>` is the index of the node on which the force is applied.\r\n* `<direction>` is either:\r\n * `X` for a horizontal force,\r\n * `Y` for a vertical force.\r\n* `<force>` the signed amplitude of the force (negative or positive float)\r\n* `[max displacement]` is the maximum displacement of the specified node along the specified direction (positive float).\r\nBeyond this value, the simulation will finish (even if the force has not been reached yet).\r\nIt is an optional parameter; if not provided, there is no maximum displacement at which the simulation can finish\r\nprematurely (it is the same as setting the maximum displacement to a value close to infinity).\r\n\r\nExample:\r\n```csv\r\nLOADING\r\n2, Y, -10.0, -3.0\r\n```\r\n>A force is applied on node `2`, along the `Y`-direction (vertical).\r\nThe magnitude of the force is `-10` (it is a negative value, so the force points downwards).\r\nThe maximum displacement is set to `-3.0`, meaning that if node `2` is displaced downward by more that `3.0`,\r\nthe simulation is assumed to have completed.\r\n\r\n> [!NOTE]\r\n> More complex loading can be specified (preloading, multiple loading steps, blocking nodes).\r\nPlease refer to [Complex loading descriptions](#complex-loading-descriptions) paragraph in the [Advanced topics](#advanced-topics) for more details.*\r\n\r\n\r\n#### A complete example\r\nThis example describes a spring structure composed of two inclined linear longitudinal springs connected in the center,\r\nand hinging through a linear rotation spring.\r\n```csv\r\n# spring model example (this is a comment)\r\n\r\nPARAMETERS\r\nwidth, 2.0\r\nheight, 1.0\r\nstiffness, 7.3\r\n\r\nNODES\r\n0, -width/2, 0.0, 1, 1\r\n1, +width/2, 0.0, 1, 1\r\n2, 0.0, height, 1, 0\r\n\r\nSPRINGS\r\n0-2, stiffness\r\n1-2, stiffness\r\nROTATION SPRINGS\r\n0-2-1, 1.5, PI/2\r\n\r\nLOADING\r\n2, Y, -10.0, -3.0\r\n```\r\n\r\n#### Additional notes\r\n* Empty lines have no semantic meaning. Adding/removing some will not change the spring model.\r\n* `#` is used to indicate a line comment. Each line starting with `#` will be ignored when reading the file.\r\n* Parameters can be combined in mathematical expression in all sections but `PARAMETERS`. Supported operations include\r\n`(...)`, `+`, `-`, `*`, `/`, `SIN(...)` (sine), `COS(...)` (cosine), `TAN(...)` (tangent), `SQRT(...)` (square root). \r\nValue \u03c0 can be used without defining it in the section `PARAMETERS` with the keyword `PI`.\r\n* If your spring assembly does not include a certain type of spring, feel free to leave the corresponding section empty (header only)\r\nor to omit it completely (no header and no content).\r\n\r\n### Specifying a nonlinear mechanical behavior\r\nTO DO\r\n\r\n### Configuring simulation settings\r\nMany settings can be tuned before running a simulation. They fall into two categories: **solver settings**\r\nor **graphics settings**.\r\n\r\nSolver settings only affect the solver (that is the part responsible to solve the nonlinear equations,\r\nby computing all the equilibrium points), while graphics settings determines what is generated to visualize a result\r\n(previously computed by the solver), and how it is going to look like.\r\n\r\nAll default solver and graphics settings along with useful documentation are listed in the files\r\n`default_solver_settings.toml` and `default_graphics_settings.toml` respectively. They are available\r\n[here on GitHub](https://github.com/ducarme/springable).\r\n\r\n\r\nWhen you wish to change a setting (let's say a solver setting),\r\ncreate a [TOML file](https://toml.io/en/), that is a text file saved with extension *.toml*. You can use the NotePad (Windows)\r\nor TextEdit (MacOS) to do that, for example. The file will look similar to this:\r\n```toml\r\n# custom_solver_settings.toml\r\nradius = 0.01\r\nreference_load_parameter = 0.01\r\n```\r\n*Low values for `radius` and `reference_load_parameter` can be used to refine the solution,\r\nat the cost of increasing the solving duration. Default values are 0.05 and 0.05, respectively.*\r\n\r\nTo use these custom solver settings, use the path to `custom_solver_settings.toml`\r\nas an extra argument of the `ss.simulate_model()` function, as follows:\r\n\r\n```python\r\n\"\"\"\r\nmy_first_simulation.py\r\nExample to learn how to use the package springable\r\n\"\"\"\r\nimport springable.simulation as ss\r\n\r\nss.simulate_model(model_path='my_spring_model.csv', save_dir='my_simulation_result',\r\n solver_settings_path='custom_solver_settings.toml')\r\n```\r\n\r\n\r\nSimilarly, when you wish to modify a graphics setting, create another TOML file and include the settings you wish to modify\r\n```toml\r\n# custom_graphics_settings.toml\r\n[animation_options]\r\nnb_frames = 240\r\nfps = 60\r\n\r\n[plot_options]\r\nshow_snapping_arrows = true\r\ndrive_mode = \"force\"\r\n```\r\n*Animation settings `nb_frames` and `fps` determine the number of frames and the frame rate (in frame per second) of the animation showing\r\nthe spring assembly deforming. Plot settings `show_snapping_arrows = true` combined with `drive_mode = \"force\"` means that\r\nyou want to indicate with arrows the (potential) snapping transitions under controlled force in the force-displacement plot.\r\nTo indicate, snapping transitions under controlled displacement use `show_snapping_arrows = true` combined with `drive_mode = \"displacement\"`\r\ninstead.*\r\n\r\nTo use these custom graphics settings, use the path to `custom_graphics_settings.toml`\r\nas an extra argument of the `ss.simulate_model()` function, as follows:\r\n\r\n```python\r\n\"\"\"\r\nmy_first_simulation.py\r\nExample to learn how to use the package springable\r\n\"\"\"\r\nimport springable.simulation as ss\r\n\r\nss.simulate_model(model_path='my_spring_model.csv', save_dir='my_simulation_result',\r\n solver_settings_path='custom_solver_settings.toml',\r\n graphics_settings_path='custom_graphics_settings.toml')\r\n```\r\n\r\n\r\n#### Additional notes\r\n* A custom settings file does not need to contain all the possible settings; just include the one you wish to modify.\r\n* Graphics settings are divided into 4 sections of settings (indicated by `[...]` in TOML files):\r\n * general options (determines _what_ should be generated and directly shown (drawing, animation, plot))\r\n * plot options (determines _how_ plots will look like)\r\n * animation options (determines _how_ animations will look like)\r\n * assembly appearance (determines _how_ the spring assembly will be depicted)\r\n\r\n### Advanced topics\r\n#### Area spring with holes\r\n#### Complex loading descriptions\r\n#### Scanning parameters\r\n\r\n## How to define your own custom springs\r\nTO DO\r\n\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Nonlinear spring assembly solver and visualization",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/ducarme/springable",
"Issues": "https://github.com/ducarme/springable/issues"
},
"split_keywords": [
"nonlinear",
" spring",
" simulation",
" animation",
" instability",
" snap-through"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2f9a43f6be5a80ea113868c7b7c7e20990641bbcf65c209b1cdd884a5d13035a",
"md5": "4727538a2bf5e2f514d70b558f9068bc",
"sha256": "4e2d580c66f4236a71ce9e90fde1e3cc24bab9af9d421029c49d2571f3497a91"
},
"downloads": -1,
"filename": "springable-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4727538a2bf5e2f514d70b558f9068bc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 105217,
"upload_time": "2024-12-16T19:23:53",
"upload_time_iso_8601": "2024-12-16T19:23:53.046072Z",
"url": "https://files.pythonhosted.org/packages/2f/9a/43f6be5a80ea113868c7b7c7e20990641bbcf65c209b1cdd884a5d13035a/springable-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b9b82605b23189ace4e7e556c884e562d284902bab0425719e29fab1fc51f4e5",
"md5": "e592c18dff288b87a41add4d9fa4fa38",
"sha256": "6b77a67834046ff1f3ccfdcc982f1f1b36e691268b8cc74992f9b1a60c807b17"
},
"downloads": -1,
"filename": "springable-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e592c18dff288b87a41add4d9fa4fa38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 102741,
"upload_time": "2024-12-16T19:23:54",
"upload_time_iso_8601": "2024-12-16T19:23:54.525886Z",
"url": "https://files.pythonhosted.org/packages/b9/b8/2605b23189ace4e7e556c884e562d284902bab0425719e29fab1fc51f4e5/springable-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 19:23:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ducarme",
"github_project": "springable",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "springable"
}
JSON
