Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Update Windows/MSVC installation instructions #2053

Merged
merged 4 commits into from
Apr 22, 2023
Merged

Doc: Update Windows/MSVC installation instructions #2053

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c015fb8
Updated description for Windows installation
Apr 21, 2023
0a3d436
added check if AMICI_DLL_DIRS is set as an enviroment variable
Apr 21, 2023
2a7b023
..
dweindl Apr 22, 2023
8aa6172
..
dweindl Apr 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 21 additions & 14 deletions documentation/python_installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,6 @@ Some general remarks:
Using the Microsoft Visual Studio
---------------------------------

.. note:: Support for MSVC is experimental.

We assume that Visual Studio (not to be confused with Visual Studio Code)
is already installed. Using Visual Studio Installer, the following components
need to be included:
Expand All @@ -121,7 +119,11 @@ OpenBLAS
^^^^^^^^

There are prebuilt OpenBLAS binaries available, but they did not seem to work
well here. Therefore, we recommend building OpenBLAS from scratch.
well here. Therefore, we recommend building OpenBLAS from scratch. This
requires an installation of CMake. CMake can be installed from
https://cmake.org/download/ (system-wide), or via ``pip install cmake``
(in the current Python environment).


To build OpenBLAS, download the following scripts from the AMICI repository:

Expand All @@ -133,27 +135,32 @@ The first script needs to be called in Powershell, and it needs to call

cmd /c "scripts\compileBLAS.cmd $version"

Additionally, in ``compileBLAS.cmd`` make sure that you point to your
Visual Studio installation on line 3.
Newer installations could be located under
``C:\Program Files\Microsoft Visual Studio\...\VC\Auxiliary\Build\vcvars64.bat``.

so that it matches your directory structure.
This will download OpenBLAS and compile it, creating

C:\\BLAS\\lib\\openblas.lib
C:\\BLAS\\bin\\openblas.dll
C:\\BLAS\\OpenBLAS\\lib\\openblas.lib
C:\\BLAS\\OpenBLAS\\bin\\openblas.dll

You will also need to define two environment variables:

.. code-block:: text

BLAS_LIBS="/LIBPATH:C:\BLAS\lib openblas.lib"
BLAS_CFLAGS="/IC:/BLAS/OpenBLAS-0.3.19/OpenBLAS-0.3.19"
BLAS_LIBS="/LIBPATH:C:/BLAS/OpenBLAS/lib openblas.lib"
BLAS_CFLAGS="/IC:/BLAS/OpenBLAS"

One way to do that is to run a PowerShell script with the following commands:

.. code-block:: text

[System.Environment]::SetEnvironmentVariable("BLAS_LIBS", "/LIBPATH:C:/BLAS/lib openblas.lib", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("BLAS_LIBS", "/LIBPATH:C:/BLAS/lib openblas.lib", [System.EnvironmentVariableTarget]::Process)
[System.Environment]::SetEnvironmentVariable("BLAS_CFLAGS", "-IC:/BLAS/OpenBLAS-0.3.19/OpenBLAS-0.3.19", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("BLAS_CFLAGS", "-IC:/BLAS/OpenBLAS-0.3.19/OpenBLAS-0.3.19", [System.EnvironmentVariableTarget]::Process)
[System.Environment]::SetEnvironmentVariable("BLAS_LIBS", "/LIBPATH:C:/BLAS/OpenBLAS/lib openblas.lib", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("BLAS_LIBS", "/LIBPATH:C:/BLAS/OpenBLAS/lib openblas.lib", [System.EnvironmentVariableTarget]::Process)
[System.Environment]::SetEnvironmentVariable("BLAS_CFLAGS", "-IC:/BLAS/OpenBLAS/include/openblas", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("BLAS_CFLAGS", "-IC:/BLAS/OpenBLAS/include/openblas", [System.EnvironmentVariableTarget]::Process)

The call ending in ``Process`` sets the environment variable in the current
process, and it is no longer in effect in the next process. The call ending in
Expand All @@ -163,7 +170,7 @@ Now you need to make sure that all required DLLs are within the scope of the
``PATH`` variable. In particular, the following directories need to be included
in ``PATH``:

C:\\BLAS\\bin
C:\\BLAS\\OpenBLAS\\bin
C:\\Program Files (x86)\\Windows Kits\\10\\Redist\\ucrt\\DLLs\\x64

The first one is needed for ``openblas.dll`` and the second is needed for the
Expand Down Expand Up @@ -205,10 +212,10 @@ by MSVC (see Visual Studio above). ``KERNEL32.dll`` is part of Windows and in

import os
# directory containing `openblas.dll`
os.add_dll_directory("C:\\BLAS\\bin")
os.add_dll_directory("C:\\BLAS\\OpenBLAS\\bin")
import amici

or via the environment variable ``AMICI_DLL_DIRS``.
or via the environment variable ``AMICI_DLL_DIRS="C:\BLAS\OpenBLAS\bin"``.

If Python returns the following error upon ``import amici``, try updating to the latest Python version.

Expand Down
8 changes: 4 additions & 4 deletions swig/amici.i
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ import_array();
%pythoncode %{
def __repr__(self):
return self.this.__repr__()[:-1] + '; ' + repr(np.asarray(self, dtype=np.float64)) + ' >'

%}
};
%template(IntVector) std::vector<int>;
Expand Down Expand Up @@ -330,13 +330,13 @@ def __repr__(self):
import sys
import os

if sys.platform == 'win32':
for dll_dir in os.environ.get("AMICI_DLL_DIRS", "").split(os.pathsep):
if sys.platform == 'win32' and (dll_dirs := os.environ.get('AMICI_DLL_DIRS')):
for dll_dir in dll_dirs.split(os.pathsep):
os.add_dll_directory(dll_dir)

%}

// import additional types for typehintsn
// import additional types for typehints
// also import np for use in __repr__ functions
%pythonbegin %{
from typing import TYPE_CHECKING, Iterable, List, Tuple, Sequence
Expand Down