Skip to content

Commit 054011e

Browse files
committed
Update compatibility documentation
1 parent 68d8525 commit 054011e

File tree

4 files changed

+23
-7
lines changed

4 files changed

+23
-7
lines changed

source/about/features/compatibility.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,12 @@ To start an interactive Tcl interpreter using *xara*, run the following command
4141
python -m opensees
4242
4343
44+
Details
45+
-------
46+
47+
While *xara* aims to be compatible with OpenSeesPy and OpenSees Tcl, there are some differences and limitations.
48+
The following pages describe this in detail:
49+
50+
- :ref:`Deprecations <about-features-deprecated>` Features of OpenSeesPy that are discouraged in *xara*, but still supported for backwards compatibility.
51+
- :ref:`Dropped Capabilities <about-features-dropped>` Features of OpenSeesPy that were *removed* in *xara*.
52+
- :ref:`Suspended Capabilities <about-features-suspended>` Features of OpenSeesPy that are temporarily disabled in *xara*, but will be added in the future.

source/about/features/dropped.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _about-features-dropped:
2+
13
Dropped Capabilities
24
^^^^^^^^^^^^^^^^^^^^
35

source/about/features/index.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
Features
22
^^^^^^^^
33

4-
Xara offers several advanced features that make it a powerful tool for nonlinear finite element analysis:
4+
A strong feature of xara is its backwards compatibility with OpenSeesPy and Tcl scripts.
5+
This compatibility is described in `Compatibility <CompatibilityLayer>`_.
6+
..
7+
Xara offers several advanced features that make it a powerful tool for nonlinear finite element analysis:
8+
- **Mixed Formulations**: It supports mixed formulations for beams and solids, enabling accurate modeling of complex structural systems.
9+
- **Extensive Material Models**: With over 200 material models, Xara provides flexibility for simulating various materials and their nonlinear behaviors.
10+
- **Performance Optimization**: Built on the OpenSeesRT framework, Xara delivers substantial performance improvements over traditional interpreters.
11+
- **Continuation Algorithms**: These algorithms are designed to solve highly nonlinear problems efficiently, making Xara suitable for challenging engineering scenarios.
12+
- **Stateless Modeling**: Xara introduces a `Model` class for true stateless modeling, allowing users to work without relying on a single global program state.
13+
- `Compatibility Layer <CompatibilityLayer>`: Although *xara* in includes a completely rewritten interpreter architecture, compatibility layers allow legacy OpenSeesPy and Tcl scripts to run with minimal modifications.
514
6-
- **Mixed Formulations**: It supports mixed formulations for beams and solids, enabling accurate modeling of complex structural systems.
7-
- **Extensive Material Models**: With over 200 material models, Xara provides flexibility for simulating various materials and their nonlinear behaviors.
8-
- **Performance Optimization**: Built on the OpenSeesRT framework, Xara delivers substantial performance improvements over traditional interpreters.
9-
- **Continuation Algorithms**: These algorithms are designed to solve highly nonlinear problems efficiently, making Xara suitable for challenging engineering scenarios.
10-
- **Stateless Modeling**: Xara introduces a `Model` class for true stateless modeling, allowing users to work without relying on a single global program state.
11-
- `Compatibility Layer <CompatibilityLayer>`: Although *xara* in includes a completely rewritten interpreter architecture, compatibility layers allow legacy OpenSeesPy and Tcl scripts to run with minimal modifications.
1215

1316
.. toctree::
1417
:hidden:

source/about/features/suspended.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _about-features-suspended:
2+
13
Suspended
24
^^^^^^^^^
35

0 commit comments

Comments
 (0)