Graphoscope

Design Principles

The library has four aspirational principles

• Performance: Be very fast to run analysis.
• Completeness: Support a broad range of use cases and easy extension.
• Ease of Use: User friendly api enabling succinct code.
• Community: Maintain excellent documention and encourage contributions.

Prerequisites

Users

• .NET 6.0 or higher (https://dotnet.microsoft.com/download/dotnet)

Developers

• .NET 6.0 or higher (https://dotnet.microsoft.com/download/dotnet)
• An IDE suited to work in the .NET and F# ecosystem, here are some suggestions:
  • Visual Studio 2022 (https://visualstudio.microsoft.com/vs/)
  • Visual Studio Code (https://code.visualstudio.com/) with the Ionide plugin (https://ionide.io/)
  • JetBrains Rider (https://www.jetbrains.com/rider/)

repo structure

• The src folder contains 1 subfolder per project.

• The tests folder contains 1 subfolder per test project.

• The docs folder contains documentation snippets (.fsx and .md files)

• The build folder contains the buildproject which contains all build tasks.

Develop

in general, dotnet tool restore must be run in the repo root once after cloning to install the dotnet tools used in this repo

The build.cmd and build.sh scripts are shorthand scripts that execute the /build/Build.fsproj build project. This build project contains various tasks.

Build

In the repo root, run the following command based on your OS:

Linux/MacOS:

./build.sh

Windows:

./build.cmd

Test

via IDE

If your IDE supports TestAdapters, open the solution and run the tests from Test Explorer.

via CLI

In the repo root, run the following command based on your OS:

Linux/MacOS:

./build.sh runTests

Windows:

./build.cmd runTests

Current Benchmark

BenchmarkDotNet=v0.13.5, OS=Windows 11 (10.0.22621.1992/22H2/2022Update/SunValley2) Intel Core i7-1065G7 CPU 1.30GHz, 1 CPU, 8 logical and 4 physical cores .NET SDK=6.0.411 [Host] : .NET 6.0.19 (6.0.1923.31806), X64 RyuJIT AVX2 DEBUG DefaultJob : .NET 6.0.19 (6.0.1923.31806), X64 RyuJIT AVX2