... | ... | @@ -21,9 +21,11 @@ By default, `salza` is distributed under the [GNU Affero General Public License, |
|
|
|
|
|
If you cannot comply with AGPLv3, please <a href="mailto:cayre@uvolante.org?Subject=Alternative Software Licensing Inquiry for SALZA">contact us</a>.
|
|
|
|
|
|
# Debian/Ubuntu repository
|
|
|
# Installing `salza`
|
|
|
|
|
|
We provide pre-compiled binaries for Debian/Ubuntu `amd64` architectures.
|
|
|
`salza` is written in C for GNU/Linux. We provide both pre-compiled binaries for Debian/Ubuntu `amd64` architectures and instructions to compile from source.
|
|
|
|
|
|
## Debian/Ubuntu repository
|
|
|
|
|
|
Please follow [these instructions](https://www.uvolante.org/apt) to add the repository to your system.
|
|
|
|
... | ... | @@ -37,16 +39,16 @@ To install the companion programs: |
|
|
sudo apt install drpt mattr2str
|
|
|
```
|
|
|
|
|
|
# Source code
|
|
|
## Source code
|
|
|
|
|
|
## Requirements
|
|
|
### Requirements
|
|
|
|
|
|
`salza` makes use of the following software:
|
|
|
|
|
|
* `clang`, `make`, `cmake`, `doxygen`, `git`,
|
|
|
* the [`oops`](https://forge.uvolante.org/code/oops/wikis) library.
|
|
|
|
|
|
## Cloning the source repository
|
|
|
### Cloning the source repository
|
|
|
|
|
|
Once `oops` is compiled and installed, clone the `git` tree:
|
|
|
```
|
... | ... | @@ -58,7 +60,7 @@ sudo make install |
|
|
```
|
|
|
The last step can be replaced with building a Debian package (type: `cpack`) to be installed with `sudo dpkg -i salza-xxxxx.deb`.
|
|
|
|
|
|
# Known issues
|
|
|
## Known issues
|
|
|
|
|
|
`salza` eats a lot of memory. Launch it with the verbose option (`-v`) to monitor its behaviour.
|
|
|
In case it is too slow, that may be because your machine had to free memory. A suggestion is to kill the process and launch it again.
|
... | ... | @@ -66,11 +68,57 @@ That proved useful in LXD containers where the guests do not have the same view |
|
|
|
|
|
In any case, all strings have to fit in memory with their associated search structures.
|
|
|
|
|
|
# Getting started
|
|
|
## Getting help
|
|
|
|
|
|
```
|
|
|
salza -h
|
|
|
```
|
|
|
# Playing with `salza`
|
|
|
|
|
|
## Basic properties
|
|
|
|
|
|
```
|
|
|
$ cat x
|
|
|
aabbababbaabbbabbabaaababababababab
|
|
|
```
|
|
|
|
|
|
### Computing self-similarity...
|
|
|
|
|
|
```
|
|
|
$ salza -s -i x
|
|
|
1.069050e+01
|
|
|
```
|
|
|
|
|
|
### ... is the same as computing the relative similarity given no prior:
|
|
|
|
|
|
```
|
|
|
$ salza -s -t relative -i x
|
|
|
1.069050e+01
|
|
|
```
|
|
|
|
|
|
### which is the same as computing the joint similarity of a string alone:
|
|
|
|
|
|
```
|
|
|
$ salza -s -t joint -i x
|
|
|
1.069050e+01
|
|
|
```
|
|
|
|
|
|
### The joint similarity of a string with copies of itself is the same as that of the string alone:
|
|
|
```
|
|
|
$ salza -s -t joint -i x,x
|
|
|
1.069050e+01
|
|
|
$ salza -s -t joint -i x,x,x
|
|
|
1.069050e+01
|
|
|
```
|
|
|
|
|
|
### The relative similarity of a string given itself is zero:
|
|
|
|
|
|
```
|
|
|
$ salza -s -i x -p x
|
|
|
0.000000e+00
|
|
|
```
|
|
|
|
|
|
##
|
|
|
|
|
|
# Reproducing the figures in the preprint
|
|
|
|
... | ... | |