Skip to content

Commit

Permalink
README edit and site update
Browse files Browse the repository at this point in the history
  • Loading branch information
attipaci committed Sep 15, 2024
1 parent 75a1786 commit c0f724a
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,16 @@ Last Updated: 14 September 2024
<a name="introduction"></a>
## Introduction

The SMA information eXchange (SMA-X) is a high performance and versatile data sharing platform for distributed software
systems. It is built around a central Redis database, and provides atomic access to structured data, including
specific branches and/or leaf nodes, with associated metadadata.
The SMA information eXchange (SMA-X) is a high performance and versatile data sharing platform for distributed
software systems. It is built around a central Redis database, and provides atomic access to structured data,
including specific branches and/or leaf nodes, with associated metadadata. SMA-X was developed at the Submillimeter
Array (SMA) observatory, where we use it to share real-time data among hundreds of computers and nearly a thousand
individual programs.

SMA-X consists of a set of server-side [LUA](https://lua.org/) scripts that run on [Redis](https://redis.io) (or one
of its forks / clones such as [Valkey](https://valkey.io) or [Dragonfly](https://dragonfly.io)); a set of libraries to
interface client applications; and a set of command-line tools build with them. Currently we provide client libraries
for C/C++ and Python 3. We may provide Java and/or Rust client libraries too in the future.
for C/C++ and Python 3. We may provide Java and/or Rust client libraries too in the future.

There are no official releases of __smax-clib__ yet. An initial 1.0.0 release is expected early/mid 2025.
Before then the API may undergo slight changes and tweaks. Use the repository as is at your own risk for now.
Expand All @@ -57,6 +59,7 @@ Some related links:

- [API documentation](https://smithsonian.github.io/smax-clib/apidoc/html/files.html)
- [Project page](https://smithsonian.github.io/smax-clib) on github.io
- [Smithsonian/smax-python](https://smithsonian.github.io/smax-python) an alternative library for Python 3.


------------------------------------------------------------------------------
Expand Down

0 comments on commit c0f724a

Please sign in to comment.