cmp

README.md

@@ -38,8 +38,8 @@ This is an experimental package that provides an *optimized* OpenSees Tcl interp
 as well as a new set of Python bindings that is both idiomatic, and free
 of global state.
 
-The package may be used as a drop-in replacement for both OpenSees and
-OpenSeesPy, and generally provides a substantial performance boost.
+The package may be used as a drop-in replacement for both OpenSees.exe and
+OpenSeesPy (see *Getting Started* below), and generally provides a substantial performance boost.
 Project objectives include:
 
 - **Performance** The `opensees` package uses the experimental 
@@ -53,10 +53,6 @@ Project objectives include:
 - **Robustness** All program state is encapsulated in user-instantiated classes,
   and global variables/singletons are avoided. This eliminates several preexisting vulnerabilities to inadvertent state corruption.
 
-- **Simplicity** With a single `pip`-install, run any OpenSees Tcl 
-  script *and* most OpenSeesPy scripts on a wide variety of Python versions.
-  No fidling with compilers or `PATH` variables.
-
 
 <!--
 - **Library semantics**
@@ -65,9 +61,11 @@ Project objectives include:
 Additional features include:
 
 - Convert OpenSeesPy scripts into equivalent Tcl files that can be used
-  for faster processing or serialization.
+  for faster processing or serialization. Unlike most conversion utilities,
+  this conversion is done *exactly* and does not rely on hand-rolled parsing.
 
-- Python versions 3.7 - 3.12 are supported on Linux.
+- The package can be installed with `pip` for Python versions 3.7 - 3.12 on Linux, MacOS and
+  Windows, but eigenvalue analysis is currently broken on Windows.
 
 > [!NOTE]
 > This package is independent of the [`openseespy`](https://pypi.org/project/openseespy)
@@ -88,7 +86,9 @@ Additional features include:
   python -m opensees
   ```
 
-- To run Python scripts, just change the import:
+- The `opensees` package exposes a compatibility layer that exactly reproduces
+  the original *OpenSeesPy* functions, but does so without mandating a single
+  global program state. To run OpenSeesPy scripts, just change the import:
   ```python
   import openseespy.opensees
   ```
@@ -97,6 +97,7 @@ Additional features include:
   import opensees.openseespy
   ```
 
+
 <!-- Badge links -->
 
 [pypi-d-image]: https://img.shields.io/pypi/dm/opensees.svg