Skip to content

Commit

Permalink
[automated site update]
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Sep 15, 2024
1 parent 3936e3c commit fd9098e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
3 changes: 2 additions & 1 deletion apidoc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,14 @@ <h2><a class="anchor" id="autotoc_md3"></a>
<p><a class="anchor" id="introduction"></a> </p>
<h2><a class="anchor" id="autotoc_md5"></a>
Introduction</h2>
<p>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 <a class="elRef" href="../../redisx/apidoc/html/structRedis.html">Redis</a> database, and provides atomic access to structured data, including specific branches and/or leaf nodes, with associated metadadata.</p>
<p>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 <a class="elRef" href="../../redisx/apidoc/html/structRedis.html">Redis</a> 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.</p>
<p>SMA-X consists of a set of server-side <a href="https://lua.org/">LUA</a> scripts that run on <a href="https://redis.io">Redis</a> (or one of its forks / clones such as <a href="https://valkey.io">Valkey</a> or <a href="https://dragonfly.io">Dragonfly</a>); 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.</p>
<p>There are no official releases of <b>smax-clib</b> 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.</p>
<p>Some related links:</p>
<ul>
<li><a href="https://smithsonian.github.io/smax-clib/apidoc/html/files.html">API documentation</a></li>
<li><a href="https://smithsonian.github.io/smax-clib">Project page</a> on github.io</li>
<li><a href="https://smithsonian.github.io/smax-python">Smithsonian/smax-python</a> an alternative library for Python 3.</li>
</ul>
<hr />
<p><a class="anchor" id="prerequisites"></a> </p>
Expand Down
11 changes: 7 additions & 4 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,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 @@ -41,6 +43,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 fd9098e

Please sign in to comment.