Metadata-Version: 2.1
Name: STEM-Vibrations
Version: 1.1
Summary: STEM model
Home-page: https://github.com/StemVibrations/STEM
Author: STEM team
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: Unix
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: numpy >=1.24
Requires-Dist: scipy >=1.10.1
Requires-Dist: plotly >=5.15.0
Provides-Extra: docs
Requires-Dist: Sphinx ==6.2.1 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ==1.2.2 ; extra == 'docs'
Provides-Extra: testing
Requires-Dist: pytest ==7.4.2 ; extra == 'testing'
Requires-Dist: pytest-cov >=4.0 ; extra == 'testing'
Requires-Dist: tox >=4.4 ; extra == 'testing'
Requires-Dist: mypy >=1.1 ; extra == 'testing'
Requires-Dist: beautifulsoup4 >=4.12 ; extra == 'testing'
Requires-Dist: matplotlib >=3.7.4 ; extra == 'testing'

```
     _______..___________. _______ .___  ___.
    /       ||           ||   ____||   \/   |
   |   (----``---|  |----`|  |__   |  \  /  |
    \   \        |  |     |   __|  |  |\/|  |
.----)   |       |  |     |  |____ |  |  |  |
|_______/        |__|     |_______||__|  |__|

```

# STEM: Soil and Track System Modeling Tool

![Tests](https://github.com/StemVibrations/STEM/actions/workflows/tests.yml/badge.svg)
[![Documentation Status](https://readthedocs.org/projects/stemvibrations/badge/?version=latest)](https://stemvibrations.readthedocs.io/)
[![codecov](https://codecov.io/gh/stemvibrations/stem/graph/badge.svg?token=0DMYCZF4BU)](https://codecov.io/gh/stemvibrations/stem)
[![PyPI version](https://img.shields.io/pypi/v/STEM-Vibrations.svg)](https://pypi.org/project/STEM-Vibrations/)
[![Python versions](https://img.shields.io/pypi/pyversions/STEM-Vibrations.svg)](https://pypi.org/project/STEM-Vibrations/)
[![License](https://img.shields.io/pypi/l/STEM-Vibrations.svg)](https://pypi.org/project/STEM-Vibrations/)

The STEM model is designed to create and analyse models of soil and track systems.
The tool provides a set of commands for creating the geometry of the model, defining the soil and track properties, setting the boundary conditions and loads, generating the mesh, and performing post-processing on the results.

## Installation

STEM can be downloaded and installed on any system that supports Python.
To install the STEM, follow the following steps:

```python
pip install STEM-Vibrations
```

Further details about the installation can be found [here](https://stemvibrations.readthedocs.io/installation.html#).

## Usage

To use STEM please refer to the tutorials available [here](https://stemvibrations.readthedocs.io/tutorials.html#).
