kongzii/sgsl

Simple scientific library for Swift based on GNU Scientific Library

SGSL

Simple scientific library for Swift based on GNU Scientific Library.

Documentation is generated automatically from master branch using jazzy and travis. Available at github pages.

Usage

Add dependency

Add a dependency in your Package.swift

.package(url: "https://github.com/kongzii/SGSL", from: "0.1.0")

Currently, SGSL depends on the system library gsl.

OSX

brew install gsl

Linux

apt install pkg-config libgsl-dev

Usage

Import whole library

You can import the whole library via

import SGSL

Import only required components

Or only specific parts

import Statistics

Usage example

import Statistics

let x = [1.0, 2.0, 3.0]
print(x.mean())

Documentation

To generate documentation, run make documentation. Files will be saved into ./Documentation folder. It is not needed to re-generate documentation in PRs, as this will be done and published automatically.

Code style

We use swiftformat with default settings.

Tests

docker-compose up --build test

Contributions

If you found missing features or bugs, please feel free to open an issue or even better, a pull request.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub