In order to use the ADiMat Server via the automatic
differentiation routines admDiffFor
,
admDiffRev
, and admHessian
and so on, your local ADiMat installation
must be properly set up to use this server. This means,
you have to register with the ADiMat Server, to configure
ADiMat to use this server, and to configure ADiMat to pass your
credentials to the server. This is explained below in detail.
Register with the ADiMat Server
Please register with the ADiMat Server using the user registration form, providing your email address, and set a password.
Configure the ADiMat Server URL
Set up the adimat-client
program to use the transformation server URL, by either:
-
setting the environment variable
ADIMAT_SERVER
-
using your OS utilities to set the environment variable
ADIMAT_SERVER=https://adimat.de/adimat/transform/
, or -
in your MATLAB
startup.m
file, by adding the linesetenv ADIMAT_SERVER https://adimat.de/adimat/transform/
-
-
or in the client configuration file, by adding the line
server https://adimat.de/adimat/transform/
Configure authentication credentials
The authentication credentials must be
passed to the ADiMat Server via the adimat-client
program. This can be achieved by either:
-
adding the line
cgi-param auth=authtoken
to the client configuration file, where the authentication token can be created at the Auth Token page after logging in to this site, or by
-
adding the line
cgi-param auth=username:password
to the client configuration file.
-
adding the command line option
--cgi-param auth=authtoken
, or--cgi-param auth=username:password
,to the field
flags
ofadmOptions
, for exampleopts = admOptions(); opts.flags = '--cgi-param auth=authtoken';
and then using
opts
withadmDiffFor
,admDiffRev
, andadmHessian
, for example[J r] = admDiffFor(@f, 1, x, opts);
The adimat-client configuration file
Most settings can be placed in the adimat-client
program, which
is located at ~/.adimat/client-options
on Linux, Unix or
MacOS or at
%USERPROFILE%\Documents\adimat\client-options
on
Windows.