# SQUIC Package
This provides an overall view of the submission for the SQUIC package. For further details, see the User Manual ``SQUIC_User_Manual``.

## Compiling and Installation
To compile SQUIC from source, goto to ``Src/lib``. The following steps will compile `libSQUIC`, the interface packages for R and Python, and run basic demos using the respective interfaces for validation:

```bash
make
make install
make install_r
make install_py
```
_For further details see `Src/lib/README.md._

## Replication 
The results in the ACM TOM Submitted Manuscript can be reproduced using the scripts in the ``/Replication`` folder.

1) Begin by downloading and unzipping the synthetic datasets (20GB) within the ``/Replication`` folder:
```bash
curl -o temp.zip https://drive.switch.ch/index.php/s/Avxc8ugzHXvW5jN/download
unzip temp.zip -d squic_test_db/
```
_The default location of the dataset is assumed to be `Replication/squic_test_db`. If this is changed, please modify the file `Replication/load_data.R` accordingly._ 

2) Then, install the required R dependencies:
```bash
Rscript install_dependencies.R 
```
_These packages are not dependencies of SQUIC, but are used in the numerical experiments._

3) From here, you can run the different experiments, for example:
```bash
Rscript test_inv.R 
```
