Skip to content

Commit

Permalink
cmp - README
Browse files Browse the repository at this point in the history
  • Loading branch information
claudioperez committed Mar 19, 2024
1 parent e63a54c commit 2018f0e
Showing 1 changed file with 27 additions and 5 deletions.
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,36 @@ of global state.

The package may be used as a drop-in replacement for both OpenSees and
OpenSeesPy, and generally provides a considerable performance boost.
Project objectives include:

- **Simpler installation** With a single `pip`-install, run any OpenSees Tcl
script **and** most OpenSeesPy scripts.

- **Performance improvements** The `opensees` package uses the experimental `OpenSeesRT`
analysis kernel which
eliminates reliance on global variables for state and memory management. Stack-allocated
matrices and vectors eliminate the need for static local variables and furnish additional
performance improvements.

- **Reliability** All program state is encapsulated in user-instantiated classes,
and global variables/singletons are avoided. This eliminates the possibility
of state corruption.

Additional features include:

- Convert OpenSeesPy scripts into serialized Tcl files that can be used
for faster processing or serialization.

- Python versions 3.7 - 3.11 are supported on Linux.

#### Getting Started

- With a single `pip`-install, run any OpenSees Tcl script **and** most OpenSeesPy scripts.
- To start a Tcl interpreter run the shell command:

```bash
python -m opensees
```

- To run Python scripts, just change the import:
```python
import openseespy.opensees
Expand All @@ -59,11 +83,9 @@ OpenSeesPy, and generally provides a considerable performance boost.
```python
import opensees.openseespy
```
- Convert OpenSeesPy scripts into serialized Tcl files that can be used
for faster processing or serialization.
- Python versions 3.7 - 3.11 are supported on Linux.

> **Note** This package is independent of the [`openseespy`](https://pypi.org/project/openseespy)
> [!NOTE]
> This package is independent of the [`openseespy`](https://pypi.org/project/openseespy)
> library, which is documented in the OpenSees [documentation](https://opensees.github.io/OpenSeesDocumentation)
> website.
Expand Down

0 comments on commit 2018f0e

Please sign in to comment.