# Set-up CaosDB.jl

## Installation

CaosDB.jl uses CaosDB's C interface which is accessed via `ccall`. So
to us CaosDB.jl, you must first build and install
[caosdb-cpplib](https://gitlab.com/caosdb/caosdb-cpplib) as explained
in its
[documentation](https://docs.indiscale.com/caosdb-cpplib). After
building the path to the shared library `libccaosdb` has to be made
known to Julia's
[`ccall`](https://docs.julialang.org/en/v1/manual/calling-c-and-fortran-code),
e.g., by adding its path to the `LD_LIBRARY_PATH`. Then, the CaosDB.jl
package can be accessed by

```julia-repl
julia> ]add "path/to/caosdb-julialib"
julia> using CaosDB
julia> connection = CaosDB.Connection.connect() # Enter host, port, path to SSL certificate, and credentials here
```

## Tests

After installing, the unit tests can be executed by

```julia-repl
julia> ]activate "/path/to/caosdb-julialib"
julia> ]test
```

## Documentation

The documentation can be built locally using
[Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) by
executing

```sh
julia --color=yes docs/make.jl
```

Afterwards the built html files can be found in `docs/build`.