From 0c9951e8500f78845d1a7eba1e142851d3540f61 Mon Sep 17 00:00:00 2001 From: Filippo Bigi <98903385+frostedoyster@users.noreply.github.com> Date: Wed, 8 Nov 2023 08:35:27 +0100 Subject: [PATCH] Preliminary Julia docs (#84) --- docs/src/api.rst | 3 +++ docs/src/examples.rst | 3 +++ docs/src/index.rst | 4 ++-- docs/src/installation.rst | 6 ++++++ 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/src/api.rst b/docs/src/api.rst index 78bc900db..e43d3ffba 100644 --- a/docs/src/api.rst +++ b/docs/src/api.rst @@ -23,3 +23,6 @@ different languages it supports. python-api pytorch-api jax-api + +Although the Julia API is not fully documented yet, basic usage examples are available +`here `_. diff --git a/docs/src/examples.rst b/docs/src/examples.rst index 38ea6419f..61c5db962 100644 --- a/docs/src/examples.rst +++ b/docs/src/examples.rst @@ -20,3 +20,6 @@ floating-point arithmetics, and they evaluate the mean relative error between th python-examples pytorch-examples jax-examples + +Although comprehensive Julia examples are not fully available yet, basic usage is illustrated +`here `_. diff --git a/docs/src/index.rst b/docs/src/index.rst index 15972ff46..c2808cfb9 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -15,8 +15,8 @@ The theory behind this efficient implementation is detailed in this `paper `_. The core library is implemented in C++ with OpenMP parallelism, and it provides -APIs for C, Python and PyTorch. In addition, the PyTorch-based implementation -provides fast spherical harmonics evaluations on GPUs using CUDA. +APIs for C, Python and PyTorch. The latter implementation provides fast spherical +harmonics evaluations on GPUs using CUDA. A native Julia package is also available. This documentation contains an installation guide, an API overview, some examples of how to use the library, and a brief explanation of the mathematics involved. diff --git a/docs/src/installation.rst b/docs/src/installation.rst index 12bb201f7..335e02805 100644 --- a/docs/src/installation.rst +++ b/docs/src/installation.rst @@ -36,6 +36,12 @@ you should build the code from source: pip install --extra-index-url https://download.pytorch.org/whl/cpu .[torch] +Julia package +------------- + +The native Julia package can be installed by opening a REPL, +switching to the package manager by typing ``]`` and then ``add SpheriCart``. + C/C++ library -------------