Yshojihep/ BulletinBoardClient

Mathematica client for BulletinBoard

Contributed by: YUTARO SHOJI

BulletinBoard is an object storage of ArrayObject, which can be used for debugging and data taking purposes. It mediates data between the program and Mathematica, enabling immediate visualization of data using a notebook. This paclet provides a Mathematica client for BulletinBoard. The BulletinBoard server can be downloaded from DockerHub, Crates.io and GitHub.

Installation Instructions

To install this paclet in your Wolfram Language environment, evaluate this code:
PacletInstall["Yshojihep/BulletinBoardClient"]


To load the code after installation, evaluate this code:
Needs["Yshojihep`BulletinBoardClient`"]

Details

Hybrid backend of memory and file, selected based on the size of the object and the allocated memory.
Key is a combination of a title and a tag. Each key contains revisions of `ArrayObject`.
Simple access to data. For example, revision can be omitted. Then, the most recent revision is returned. The tag can also be omitted if no other tags are present.
The commands `archive` and `dump` make data persistent. (Data does not persist by default.)
Unix sockets can be used with Unix-like operating systems, which makes the communication speed quite fast.

Paclet Guide

Examples

Basic Examples (3) 

After installing this paclet, you need to build the library. For compilation, a standard C++ build environment is required.

In[1]:=
BBBuildLibrary[]

Post a bulletin:

In[2]:=
BBPost["x", {1, 2, 3}];

Show all the bulletins:

In[3]:=
BBViewBoard[]
Out[3]=

Read a bulletin:

In[4]:=
BBRead["x"]
Out[4]=

Scope (6) 

Set the server address:

In[5]:=
BBSetAddr["192.168.3.1:7578"];

Reset the server:

In[6]:=
BBResetServer[];

Read multiple revisions:

In[7]:=
BBPost["x", {1, 2, 3}]; BBPost["x", {4, 5, 6, 7}];
BBRead["x", {0, 1}]
Out[8]=

Archive a bulletin:

In[9]:=
BBArchive["acv", "x"];

Load an archive:

In[10]:=
BBLoad["acv"];

Delete an archive:

In[11]:=
BBDeleteArchive["acv"];

Remove a bulletin:

In[12]:=
BBRemove["x"];

Publisher

Yutaro Shoji

Disclosures

Compatibility

Wolfram Language Version 13.0

Version History

  • 1.0.3 – 09 December 2024
  • 1.0.2 – 16 November 2024
  • 1.0.1 – 15 November 2024
  • 1.0.0 – 14 November 2024
  • 0.3.0 – 11 November 2024

License Information

Apache License 2.0

Paclet Source

Source Metadata