Getting started

Requirements

  • Unix-based OS

  • gcc compiler with c++17 support

  • CMake version >= 3.8

  • Python interpreter version >= 3.4

  • pip

Installation

The procedure for installing sdfTools is as follows:

  1. Get the up-to-date version of the code:

    $ git clone git@github.com:amlucas/sdfTools.git --recursive
    
  2. Compile and install the code through pip

    $ cd sdfTools
    $ python -m pip install .
    
  3. Now you should be able to use sdf_tools in your python scripts:

    import sdf_tools
    

Testing

It is possible to test the installation by typing

$ cd tests
$ ./run.sh test_*.py