Skip to content

Commit

Permalink
be clearer
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvanmele committed Mar 2, 2024
1 parent dd32ba5 commit e8fc698
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@ COMPAS Assembly

.. rst-class:: lead

:mod:`compas_assembly` contains data structures and algorithms for modelling the individual
elements of Discrete Element Assemblies or Models, and the connections and relationships between them.
The package itself **DOES NOT** provide tools or solvers for computing contact forces between the elements,
nor for analysing the stability of entire assemblies.
To enable such calculations, you have to install additional solver packages such as :mod:`compas_rbe`.
:mod:`compas_assembly` provides a lightweight data structure for representing
Discrete Element Models (DEMs), the individual elements,
and interactions between elements.

.. warning::

COMPAS Assembly itself doen's provide any equilibrium solvers.
To compute the equilibrium forces of assemblies under influence of external loads,
you should install an equilibrium solver, such as `compas_cra <https://blockresearchgroup.github.io/compas_cra>`_.


Table of Contents
=================
Expand Down

0 comments on commit e8fc698

Please sign in to comment.