Preliminary Julia docs (#84)

lab-cosmo · Nov 8, 2023 · 0c9951e · 0c9951e
1 parent b85b098
commit 0c9951e
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 2 deletions.
diff --git 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 <https://github.com/lab-cosmo/sphericart/blob/main/julia/README.md>`_.
diff --git 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 <https://github.com/lab-cosmo/sphericart/blob/main/julia/README.md>`_.
diff --git 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 <https://arxiv.org/abs/2302.08381>`_. 
 
 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
@@ -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
 -------------