Crates.io | wolfram-app-discovery |
lib.rs | wolfram-app-discovery |
version | 0.4.8 |
source | src |
created_at | 2022-02-08 19:35:14.266503 |
updated_at | 2023-06-14 14:49:44.618812 |
description | Find local installations of the Wolfram Language |
homepage | |
repository | https://github.com/WolframResearch/wolfram-app-discovery-rs |
max_upload_size | |
id | 529283 |
size | 219,226 |
Find local installations of the Wolfram Language and Wolfram applications.
This crate provides:
wolfram-app-discovery
Rust crate (API docs)wolfram-app-discovery
command-line tool (CLI docs, Installation)Locate the default Wolfram Language installation on this computer:
use wolfram_app_discovery::WolframApp;
let app = WolframApp::try_default()
.expect("unable to locate any Wolfram applications");
// Prints a path like:
// $InstallationDirectory: /Applications/Mathematica.app/Contents/
println!("$InstallationDirectory: {}", app.installation_directory().display());
See also: WolframApp::try_default()
Locate the default Wolfram Language installation on this computer:
$ wolfram-app-discovery default
App type: Mathematica
Wolfram Language version: 13.1.0
Application directory: /Applications/Wolfram/Mathematica.app
See CommandLineHelp.md for more information on the
wolfram-app-discovery
command-line interface.
Suppose you have the following C program that provides a function via the Wolfram LibraryLink interface, which you would like to compile and call from Wolfram Language:
#include "WolframLibrary.h"
/* Adds one to the input, returning the result */
DLLEXPORT int increment(
WolframLibraryData libData,
mint argc,
MArgument *args,
MArgument result
) {
mint arg = MArgument_getInteger(args[0]);
MArgument_setInteger(result, arg + 1);
return LIBRARY_NO_ERROR;
}
To successfully compile this program, a C compiler will need to be able to find
the included "WolframLibrary.h"
header file. We can use wolfram-app-discovery
to get the path to the appropriate directory:
# Get the LibraryLink includes directory
$ export WOLFRAM_C_INCLUDES=`wolfram-app-discovery default --raw-value library-link-c-includes-directory`
And then pass that value to a C compiler:
# Invoke the C compiler
$ clang increment.c -I$WOLFRAM_C_INCLUDES -shared -o libincrement
The resulting compiled library can be loaded into Wolfram Language using
LibraryFunctionLoad
and then called:
func = LibraryFunctionLoad["~/libincrement", "increment", {Integer}, Integer];
func[5] (* Returns 6 *)
wolfram-app-discovery
Download wolfram-app-discovery
releases.
Precompiled binaries for the wolfram-app-discovery
command-line tool are
available for all major platforms from the GitHub Releases page.
wolfram-app-discovery
can be installed using cargo
(the Rust package manager) by executing:
$ cargo install --features=cli wolfram-app-discovery
This will install the latest version of
wolfram-app-discovery
from crates.io.
The default method used to locate a Wolfram Language installation
(WolframApp::try_default()
) will use the following
steps to attempt to locate any local installations, returning the first one found:
WOLFRAM_APP_DIRECTORY
environment variable, if set.wolframscript
is on PATH
, use it to locate the system installation.Specify a particular Wolfram Language installation to use (on macOS):
$ export WOLFRAM_APP_DIRECTORY="/Applications/Mathematica.app"
This environment variable is checked by both the wolfram-app-discovery
library and
command-line executable.
Licensed under either of
at your option.
Wolfram applications are covered by different licensing terms than wolfram-app-discovery
.
Wolfram Engine Community Edition is a free distribution of the Wolfram Language, licensed for personal and non-production use cases.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
See CONTRIBUTING.md for more information.
See Development.md for instructions on how to perform common development tasks when contributing to this project.
See Maintenance.md for instructions on how to maintain this project.