Windows Installation Instructions¶
Warning
If you want to install the bleeding-edge or development version of Aesara from GitHub, please make sure you are reading the latest version of this page.
Requirements¶
Note
We only support the installation of the requirements through conda.
- Python == >= 3.7
- The conda distribution is highly recommended. Python 2.4 was supported up to and including the release 0.6. Python 2.6 was supported up to and including the release 0.8.2. Python 3.3 was supported up to and including release 0.9. Python 3.6 was supported up to and including release 2.3.4.
- NumPy >= 1.9.1
- Earlier versions could work, but we don’t test it.
- SciPy >= 0.14
- Only currently required for sparse matrix and special functions support, but highly recommended. SciPy >=0.8 could work, but earlier versions have known bugs with sparse matrices.
- BLAS installation (with Level 3 functionality)
- Recommended: MKL, which is free through Conda with
mkl-service
package.- Alternatively, we suggest to install OpenBLAS, with the development headers (
-dev
,-devel
, depending on your Linux distribution).
Optional requirements
- GCC compiler with
g++
(version >=4.2.*
), and Python development files- Highly recommended. Aesara can fall back on a NumPy-based Python execution model, but a C compiler allows for vastly faster execution.
- Sphinx >= 0.5.1, pygments
- For building the documentation. LaTeX and dvipng are also necessary for math to show up as images.
- pydot-ng
- To handle large picture for gif/images.
- warp-ctc
- Required for Aesara CTC implementation. It is faster then using an equivalent graph of Aesara ops.
Requirements installation through Conda (recommended)¶
Install Miniconda¶
Follow this link to install Miniconda.
Note
If you want fast compiled code (recommended), make sure you have g++
installed.
Install requirements and optional packages¶
conda install numpy scipy mkl-service libpython <m2w64-toolchain> pytest <sphinx> <pydot-ng> <git>
Note
- Arguments between <…> are optional.
m2w64-toolchain
package provides a fully-compatible version of GCC and is then highly recommended.git
package installs git source control through conda, which is required for the development version of Aesara
Installation¶
Stable Installation¶
With conda
¶
If you use conda, you can directly install aesara. .. code-block:: bash
conda install aesara
With pip
¶
aesara¶
Install the latest stable version of Aesara with:
<sudo> pip install <--user> Aesara[test, doc]
- Any argument between <…> is optional.
- Use sudo for a root installation.
- Use user for a user installation without admin rights. It will install Aesara in your local site-packages.
- Use
pip install -r requirements.txt
to install the requirements for testing. - Use
pip install -r requirements-rtd.txt
install the requirements for generating the documentation.
If you encountered any trouble, head to the Troubleshooting page.
Bleeding-Edge Installation (recommended)¶
Install the latest, bleeding-edge, development version of Aesara with:
<sudo> pip install <--user> <--no-deps> git+https://github.com/aesara-devs/aesara.git#egg=aesara
- Any argument between <…> is optional.
- Use sudo for a root installation.
- Use user for a user installation without admin rights. It will install Aesara in your local site-packages.
- Use no-deps when you don’t want the dependencies of Aesara to be installed through pip. This is important when they have already been installed as system packages.
If you encountered any trouble, head to the Troubleshooting page.
Developer Installation¶
Install the developer version of Aesara with:
git clone git://github.com/aesara-devs/aesara.git
cd aesara
<sudo> pip install <--user> <--no-deps> -e .
- Any argument between <…> is optional.
- Use sudo for a root installation.
- Use user for a user installation without admin rights. It will install Aesara in your local site-packages.
- Use no-deps when you don’t want the dependencies of Aesara to be installed through pip. This is important when they have already been installed as system packages.
- -e makes your installation editable, i.e., it links it to your source directory.
If you encountered any trouble, head to the Troubleshooting page.
Instructions for other Python distributions (not recommended)¶
If you plan to use Aesara with other Python distributions, these are generic guidelines to get a working environment:
Look for the mandatory requirements in the package manager’s repositories of your distribution. Many distributions come with
pip
package manager which use PyPI repository. The required modules are Python (of course), NumPy, SciPy and a BLAS implementation (MKL or OpenBLAS). Use the versions recommended at the top of this documentation.If the package manager provide a GCC compiler with the recommended version (see at top), install it. If not, you could use the build TDM GCC which is provided for both 32- and 64-bit platforms. A few caveats to watch for during installation:
- Install to a directory without spaces (we have placed it in
C:\SciSoft\TDM-GCC-64
)- If you don’t want to clutter your system PATH un-check
add to path
option.- Enable OpenMP support by checking the option
openmp support option
.