DataSpaces

https://dspaces.readthedocs.io/en/latest/
Admin
DataSpaces is a communication library that enables highly-scalable data access and transfer between...
Tokens:6,132
Snippets:25
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get DataSpaces Server Executable Path with pkg-config

Source: https://dspaces.readthedocs.io/en/latest/_sources/usage

Retrieves the installation path for the standalone DataSpaces server binary using the pkg-config tool.

```console
pkg-config --variable=exec_prefix dspaces
```

--------------------------------

### Manually Configure DataSpaces Examples

Source: https://dspaces.readthedocs.io/en/latest/examples

This snippet demonstrates the manual steps to configure DataSpaces examples if cmake is not used. It involves copying the 'opts.mk.in' file to 'opts.mk' and specifying a valid C compiler, typically 'mpicc'. This allows for building and running DataSpaces programs.

```bash
cp opts.mk.in opts.mk
export CC=mpicc
```

--------------------------------

### Get DataSpaces Server Path using pkg-config

Source: https://dspaces.readthedocs.io/en/latest/usage

Find the installation path for the DataSpaces server binary ('dspaces_server') using the pkg-config utility.

```bash
pkg-config --variable=exec_prefix dspaces
```

--------------------------------

### Install DataSpaces using Spack

Source: https://dspaces.readthedocs.io/en/latest/_sources/installation

This command installs the DataSpaces package and all its dependencies using Spack. Once installed, DataSpaces can be loaded into the environment.

```console
spack install dataspaces
```

--------------------------------

### Install DataSpaces using Spack

Source: https://dspaces.readthedocs.io/en/latest/installation

This command installs the DataSpaces package and all its dependencies using Spack. Spack handles the resolution and installation of required libraries and tools.

```Shell
spack install dataspaces
```

--------------------------------

### Add DataSpaces Spack Repository

Source: https://dspaces.readthedocs.io/en/latest/_sources/installation

This snippet shows how to clone the DataSpaces Spack repository and add it to your Spack installation. This step is necessary to make the DataSpaces package available for installation via Spack.

```console
git clone https://github.com/rdi2dspaces/dspaces-spack.git
spack repo add dspaces-spack
```

--------------------------------

### Run DataSpaces Server

Source: https://dspaces.readthedocs.io/en/latest/_sources/running

The DataSpaces server binary (`dspaces_server`) is executed with a single argument: the listen address, which specifies the communication protocol and address. Examples include TCP sockets, shared memory, and RDMA over various fabrics.

```bash
dspaces_server sockets
dspaces_server sm
dspaces_server ofi+verbs
```

--------------------------------

### Add DataSpaces Spack Repository

Source: https://dspaces.readthedocs.io/en/latest/installation

This snippet shows how to clone the DataSpaces Spack repository from GitHub and add it as a local Spack repository. This is a prerequisite for installing DataSpaces using Spack.

```Shell
git clone https://github.com/rdi2dspaces/dspaces-spack.git
spack repo add dspaces-spack
```

--------------------------------

### Load DataSpaces Environment

Source: https://dspaces.readthedocs.io/en/latest/installation

After installation, this command loads the DataSpaces environment. It configures the system to use DataSpaces by updating PATH and library paths, making it easier to build and run applications that utilize DataSpaces.

```Shell
spack load dataspaces
```

--------------------------------

### Load DataSpaces Environment

Source: https://dspaces.readthedocs.io/en/latest/_sources/installation

This command loads the DataSpaces package into the current environment. It configures necessary paths like PATH and LD_LIBRARY_PATH to use DataSpaces for building and running applications.

```console
spack load dataspaces
```

--------------------------------

### Get C/C++ Linking Flags with pkg-config

Source: https://dspaces.readthedocs.io/en/latest/_sources/usage

Retrieves the necessary linking flags for building a C/C++ program that utilizes the DataSpaces API using the pkg-config tool.

```console
pkg-config --libs dspaces
```

--------------------------------

### Get C/C++ Compilation Flags with pkg-config

Source: https://dspaces.readthedocs.io/en/latest/_sources/usage

Retrieves the necessary compilation flags for building a C/C++ program that utilizes the DataSpaces API using the pkg-config tool.

```console
pkg-config --cflags dspaces
```

--------------------------------

### DataSpaces Server Configuration

Source: https://dspaces.readthedocs.io/en/latest/running

The DataSpaces server configuration file (`dataspaces.conf`) specifies various parameters for server operation. Each line in the file defines a variable and its value, separated by an equals sign.

```configuration
num_apps = 1
ndim = 1
dims = 1024
max_versions = 1
hash_version = 1
```

--------------------------------

### Configure DataSpaces Server (`dataspaces.conf`)

Source: https://dspaces.readthedocs.io/en/latest/_sources/running

The DataSpaces server configuration file (`dataspaces.conf`) specifies parameters like the number of client calls to kill the server, dimensions for data domains, and caching behavior. The format is `<variable> = <value>`.

```text
num_apps = 1
ndim = 10
dims = 1024
max_versions = 10
hash_version = 1
```

--------------------------------

### DataSpaces Server Command Line

Source: https://dspaces.readthedocs.io/en/latest/running

The DataSpaces server binary (`dspaces_server`) accepts a single argument: the listen address. This address is a Mercury-specific connection string used for establishing communication.

```bash
./dspaces_server sockets
./dspaces_server sm
./dspaces_server ofi+verbs
```

--------------------------------

### Compile C/C++ with DataSpaces using pkg-config

Source: https://dspaces.readthedocs.io/en/latest/usage

Obtain compilation flags for building a C/C++ program that utilizes the DataSpaces API using the pkg-config utility.

```bash
pkg-config --cflags dspaces
```

--------------------------------

### Link C/C++ with DataSpaces using pkg-config

Source: https://dspaces.readthedocs.io/en/latest/usage

Retrieve linking flags required for building a C/C++ program that links against the DataSpaces API using the pkg-config utility.

```bash
pkg-config --libs dspaces
```

--------------------------------

### Use DataSpaces Python Bindings

Source: https://dspaces.readthedocs.io/en/latest/usage

Guidance on using DataSpaces Python bindings by ensuring the correct directory is in the PYTHONPATH and importing the 'dspaces' module.

```python
import dspaces
```

--------------------------------

### Use DataSpaces Python Bindings

Source: https://dspaces.readthedocs.io/en/latest/_sources/usage

Explains how to set up and use the Python bindings for DataSpaces. This typically involves adding the DataSpaces library path to the PYTHONPATH environment variable and importing the 'dspaces' module.

```python
import dspaces
```

--------------------------------

### Integrate Fortran with DataSpaces in CMake

Source: https://dspaces.readthedocs.io/en/latest/usage

Configure a CMake project to automatically handle DataSpaces compilation for Fortran programs by finding the package and linking the Fortran component.

```cmake
find_package(dspaces)
target_link_libraries(your_target_name dspaces::fortran)
```

--------------------------------

### Integrate DataSpaces in CMake Projects

Source: https://dspaces.readthedocs.io/en/latest/usage

Instructions for integrating DataSpaces into a CMake project by finding the package and linking the DataSpaces library.

```cmake
find_package(dspaces)
target_link_libraries(your_target_name dspaces::dspaces)
```

--------------------------------

### Include DataSpaces in CMake Project (C/C++)

Source: https://dspaces.readthedocs.io/en/latest/_sources/usage

Demonstrates how to integrate DataSpaces into a CMake project for C/C++ applications. It involves finding the package and linking the DataSpaces library to the target.

```cmake
find_package(dspaces)
target_link_libraries(your_target_name dspaces::dspaces)
```

--------------------------------

### Include DataSpaces in CMake Project (Fortran)

Source: https://dspaces.readthedocs.io/en/latest/_sources/usage

Shows how to configure a CMake project to automatically handle DataSpaces compilation for Fortran applications. This involves finding the package and linking the Fortran-specific DataSpaces components.

```cmake
find_package(dspaces)
target_link_libraries(your_target_name dspaces::fortran)
```

--------------------------------

### DataSpaces Environment Variables

Source: https://dspaces.readthedocs.io/en/latest/_sources/running

Environment variables can be used to control DataSpaces behavior, such as enabling debug output or setting the number of server request handling threads.

```bash
export DSPACES_DEBUG=1
export DSPACES_DEFAULT_NUM_HANDLERS=8
```

--------------------------------

### DataSpaces Environment Variables

Source: https://dspaces.readthedocs.io/en/latest/running

Environment variables can be used to control the behavior and debugging output of DataSpaces clients and servers. These variables influence debug logging and the number of request handling threads.

```bash
export DSPACES_DEBUG=1
export DSPACES_DEFAULT_NUM_HANDLERS=8
```
Tokens:
Raw