AngouriMath

Navigation

Home Quick start Wiki Almanac Research What's new Try Use Angouri.org GitHub Report a bug Donate Contacts

Quick start

The following page is a short instruction for getting started with AngouriMath. You may also need to address the following resources:

GitHub Repository · Wiki guide · Discord chat

Install for C# and F#

dotnet add package MyPackage

Install for C#

dotnet add package AngouriMath --prerelease

Install for F#

dotnet add package AngouriMath.FSharp --prerelease

Install nightly build

https://www.myget.org/F/angourimath/api/v3/index.json

dotnet new nugetconfig
dotnet nuget add source https://www.myget.org/F/angourimath/api/v3/index.json
dotnet add package AngouriMath --prerelease

Install for Notebooks

First, make sure to have installed Interactive for .NET: follow the instructions from the official repository.

Now you need to run a special command right in your notebook:

For F#

#r "nuget:AngouriMath.Interactive, *-*"

For C#

#r "nuget:AngouriMath, *-*"

Nightly builds

#i "https://www.myget.org/F/angourimath/api/v3/index.json"

AngouriMath Terminal

AngouriMath.Terminal is a TUI program to interact with AngouriMath without creating project/opening IDE/etc., basically using it as your own calculator. Choose the right link for your OS to down it:

✅ - tested. If you'd like, you're welcome to test for another architecture

Run it:

For Debian/Ubuntu users

sudo apt install ./angourimath-terminal-your-arch.deb

For all others

Wben it's running, it may take some time to start the kernel. Once started, you can type in F#. To verify it works, type:

solutions "x" "sin(x) = 1/2"

AngouriMath CLI

amcli is a Command Line Interface for AngouriMath. Although it is not as feature-rich, it may be useful for some automation scripts without the need to use AM library within .NET. It's lightweight and with negligible start up time. Choose the right link for your OS to down it:

✅ - tested. If you'd like, you're welcome to test for another architecture

Run it:

For Debian/Ubuntu users

sudo apt install ./amcli-your-arch.deb

For all others

Run to get detailed help with examples:

amcli help

Install for C++ (experimental)

Consuming from C++ is available for CMake.

1. Here you need to add a language requirement:

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

include(FetchContent)
FetchContent_Declare(
    AngouriMath
    GIT_REPOSITORY https://github.com/asc-community/AngouriMathLab
    GIT_TAG        origin/cpp-release
)
FetchContent_MakeAvailable(AngouriMath)

angourimath_to_executable(${YOUR_EXECUTABLE_NAME})

Hello, world!

To verify you have everything installed correctly, let us write a simple program, computing a derivative:

C# code:

using AngouriMath;
using System;
Entity expr = "x + sin(y x)";
Console.WriteLine(expr);
Console.WriteLine(expr.Differentiate("x"));

F# code:

open Core
open Functions
let expr = parse "x + sin(y x)"
printf "%O" expr
printf "\n"
printf "%O" (differentiate "x" expr)

Jupyter:

#r "nuget:AngouriMath.Interactive, *-*"
open Core
open Functions
let expr = parse "x + sin(y x)"
differentiate "x" expr

C++ code:

#include <AngouriMath.h>;
AngouriMath::Entity expr = "x + sin(y x)";
std::cout << expr.Differentiate("x");

What's next?

You can check examples and wiki. We also recommend joining our Discord chat, so that we could help and you can give a feedback. The full documentation is in the almanac. The repository (with the source code) is on GitHub.