Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@ameli
ameli committed Dec 4, 2023
1 parent 7055b5e commit dc7e78b
Show file tree
Hide file tree
Showing 5 changed files with 75 additions and 65 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/deploy-conda.yml
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: deploy-conda

on:
push:
branches:
- main
# push:
# branches:
# - main
release:
types:
- published
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/deploy-pypi.yml
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: deploy-pypi

on:
push:
branches:
- main
# push:
# branches:
# - main
release:
types:
- published
Expand Down
60 changes: 31 additions & 29 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,35 +51,35 @@ Successful installation and tests performed on the following operating systems,
.. |y| unicode:: U+2714
.. |n| unicode:: U+2716

+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Platform | Arch | Device | Python Version | PyPy Version | Continuous |
+ | + +-------+-------+-------+-------+-------+-------+-------+ Integration +
| | | | 3.9 | 3.10 | 3.11 | 3.12 | 3.8 | 3.9 | 3.10 | |
+==========+===========+========+=======+=======+=======+=======+=======+=======+=======+=================+
| Linux | X86-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |build-linux| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ +-----------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | AARCH-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| macOS | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-macos| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+ +-----------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Windows | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-windows| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ +-----------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Platform | Arch | Device | Python Version | PyPy Version | Continuous |
+ | + +-------+-------+-------+-------+-------+-------+-------+ Integration +
| | | | 3.9 | 3.10 | 3.11 | 3.12 | 3.8 | 3.9 | 3.10 | |
+==========+===================+========+=======+=======+=======+=======+=======+=======+=======+=================+
| Linux | X86-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |build-linux| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ +-------------------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | AARCH-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| macOS | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-macos| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+ +-------------------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64:sup:`1` | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Windows | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-windows| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ +-------------------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+

.. |build-linux| image:: https://img.shields.io/github/actions/workflow/status/ameli/imate/build-linux.yml
:target: https://github.com/ameli/imate/actions?query=workflow%3Abuild-linux
Expand All @@ -90,6 +90,8 @@ Successful installation and tests performed on the following operating systems,

Python wheels for ``imate`` for all supported platforms and versions in the above are available through `PyPI <https://pypi.org/project/imate/>`_ and `Anaconda Cloud <https://anaconda.org/s-ameli/imate>`_. If you need ``imate`` on other platforms, architectures, and Python or PyPy versions, `raise an issue <https://github.com/ameli/imate/issues>`_ on GitHub and we build its Python Wheel for you.

:sup:`1. Wheels for ARM-64 architecture, specifically designed for Apple Silicon M1 machines, can only be installed using *pip* and are not available for installation via *conda*.`

Supported GPU Architectures
===========================

Expand Down
60 changes: 31 additions & 29 deletions docs/source/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,35 +82,35 @@ Successful installation and tests performed on the following operating systems,
.. |y| unicode:: U+2714
.. |n| unicode:: U+2716

+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Platform | Arch | Device | Python Version | PyPy Version | Continuous |
+ | + +-------+-------+-------+-------+-------+-------+-------+ Integration +
| | | | 3.9 | 3.10 | 3.11 | 3.12 | 3.8 | 3.9 | 3.10 | |
+==========+===========+========+=======+=======+=======+=======+=======+=======+=======+=================+
| Linux | X86-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |build-linux| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ +-----------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | AARCH-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| macOS | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-macos| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+ +-----------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Windows | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-windows| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ +-----------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+----------+-----------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Platform | Arch | Device | Python Version | PyPy Version | Continuous |
+ | + +-------+-------+-------+-------+-------+-------+-------+ Integration +
| | | | 3.9 | 3.10 | 3.11 | 3.12 | 3.8 | 3.9 | 3.10 | |
+==========+===================+========+=======+=======+=======+=======+=======+=======+=======+=================+
| Linux | X86-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |build-linux| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ +-------------------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | AARCH-64 | CPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |y| | |y| | |y| | |
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| macOS | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-macos| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+ +-------------------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64:sup:`1` | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |n| | |n| | |n| | |n| | |n| | |n| | |n| | |
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+
| Windows | X86-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |build-windows| |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ +-------------------+--------+-------+-------+-------+-------+-------+-------+-------+ +
| | ARM-64 | CPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+ + +--------+-------+-------+-------+-------+-------+-------+-------+ +
| | | GPU | |y| | |y| | |y| | |y| | |n| | |n| | |n| | |
+----------+-------------------+--------+-------+-------+-------+-------+-------+-------+-------+-----------------+

.. |build-linux| image:: https://img.shields.io/github/actions/workflow/status/ameli/imate/build-linux.yml
:target: https://github.com/ameli/imate/actions?query=workflow%3Abuild-linux
Expand All @@ -121,6 +121,8 @@ Successful installation and tests performed on the following operating systems,

Python wheels for |project| for all supported platforms and versions in the above are available through `PyPI <https://pypi.org/project/imate/>`_ and `Anaconda Cloud <https://anaconda.org/s-ameli/imate>`_. If you need |project| on other platforms, architectures, and Python or PyPy versions, `raise an issue <https://github.com/ameli/imate/issues>`_ on GitHub and we build its Python Wheel for you.

:sup:`1. Wheels for ARM-64 architecture, specifically designed for Apple Silicon M1 machines, can only be installed using *pip* and are not available for installation via *conda*.`

Install
=======

Expand Down
8 changes: 7 additions & 1 deletion docs/source/install/dependencies.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,13 @@ The followings are dependencies used during the runtime of |project|. Note that,
OpenMP (`Required`)
-------------------

The |project| requires OpenMP, which is typically included with C++ compilers on Unix-based systems like Linux. By installing a C++ compiler on Linux, you generally obtain OpenMP as well. However, for macOS users, it's crucial to note that OpenMP is not part of the default LLVM Clang C++ compiler. Even if you have Clang installed on macOS, you will still need to install OpenMP separately. For Windows users, OpenMP support depends on the compiler you choose; Microsoft Visual C++ supports OpenMP, but you may need to enable it explicitly. Below are the specific installation for each operating system:
|project| requires OpenMP, which is typically included with most C++ compilers.

* For **Linux** users, by installing a C++ compiler such as GCC or Clang, you also obtain OpenMP as well. You may alternatively install ``libomp`` without the need to install a full compiler.
* For **macOS** users, it's crucial to note that OpenMP is not part of the default LLVM Clang C++ compiler. Even if you have Clang installed on macOS, you will still need to install OpenMP separately through Homebrew (see below).
* For **Windows** users, OpenMP support depends on the compiler you choose; Microsoft Visual C++ supports OpenMP, but you may need to enable it explicitly.

Below are the specific installation for each operating system:

.. tab-set::

Expand Down

0 comments on commit dc7e78b

Please sign in to comment.