Add LODE tutorial

.gitignore

@@ -1,4 +1,5 @@
 docs/src/examples
+docs/src/index.rst
 
 *build*
 *egg-info/

.readthedocs.yml

@@ -12,6 +12,7 @@ build:
     - cmake
   tools:
     python: "3.10"
+    rust: "1.61"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

docs/requirements-rascal.txt

@@ -1,4 +1,4 @@
-# rascal needs to be in a separate requirements file because  we need to specify
+# rascal needs to be in a separate requirements file because we need to specify
 # the packages index-url for it te use the prebuilt from 
 # from https://github.com/Luthaf/nightly-wheels
 # extra-url does not work here because there is another rascal package on pypi

docs/requirements.txt

@@ -1,3 +1,4 @@
+--extra-index-url https://luthaf.fr/nightly-wheels/
 # Sphinx
 sphinx
 sphinx_rtd_theme
@@ -19,6 +20,7 @@ scipy
 scikit-learn
 skmatter
 chemiscope
+equisolve @ https://github.com/lab-cosmo/equisolve/archive/pre_build.zip
 
-# Luthaf nightly wheels
-# git+https://github.com/Luthaf/rascaline.git
+equistore
+rascaline

docs/src/conf.py

@@ -1,17 +1,12 @@
 # Sphinx documentation build configuration file
 import os
 
+# Add any Sphinx extension module names here, as strings.
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.doctest",
-    "sphinx.ext.todo",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.extlinks",
-    "sphinx_gallery.gen_gallery",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.inheritance_diagram",
-    "jupyter_sphinx",
+    'sphinx.ext.autodoc', # import the modules you are documenting
+    'sphinx.ext.intersphinx', # generate links to the documentation of objects in external projects
+    "sphinx.ext.viewcode", # add links to highlighted source code
+    "sphinx_gallery.gen_gallery", # provides a source parser for *.ipynb files
 ]
 
 examples_root = os.path.join(os.getcwd(), '../../examples/')
@@ -59,3 +54,22 @@
 
 with open('index.rst', 'w') as f:
     f.write(root_index_rst_content)
+
+# Configuration for intersphinx: refer to the Python standard library
+# and other packages used by the cookbook
+
+intersphinx_mapping = {
+    "ase": ("https://wiki.fysik.dtu.dk/ase/", None),
+    "chemiscope": ('https://chemiscope.org/docs/', None),
+    "equistore": ("https://lab-cosmo.github.io/equistore/latest/", None),
+    "equisolve": ("https://lab-cosmo.github.io/equisolve/latest/", None),
+    "matplotlib": ("https://matplotlib.org/stable/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "python": ("https://docs.python.org/3", None),
+    "rascaline": ("https://luthaf.fr/rascaline/latest/", None),
+    "rascal": ("https://lab-cosmo.github.io/librascal/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "sklearn": ('http://scikit-learn.org/stable',
+               (None, './_intersphinx/sklearn-objects.inv')),
+    "skmatter": ("https://scikit-matter.readthedocs.io/en/latest/", None),
+}

docs/src/lode_linear/index.rst

@@ -0,0 +1,59 @@
+:orphan:
+
+LODE Tutorial
+=============
+
+
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbnails">
+
+
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="This tutorial explains how Long range equivariant descriptors can be constructed using rascalin...">
+
+.. only:: html
+
+  .. image:: /lode_linear/images/thumb/sphx_glr_lode_tutorial_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_lode_linear_lode_tutorial.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">LODE Tutorial</div>
+    </div>
+
+
+.. raw:: html
+
+    </div>
+
+
+.. toctree::
+   :hidden:
+
+   /lode_linear/lode_tutorial
+
+
+.. only:: html
+
+  .. container:: sphx-glr-footer sphx-glr-footer-gallery
+
+    .. container:: sphx-glr-download sphx-glr-download-python
+
+      :download:`Download all examples in Python source code: lode_linear_python.zip </lode_linear/lode_linear_python.zip>`
+
+    .. container:: sphx-glr-download sphx-glr-download-jupyter
+
+      :download:`Download all examples in Jupyter notebooks: lode_linear_jupyter.zip </lode_linear/lode_linear_jupyter.zip>`
+
+
+.. only:: html
+
+ .. rst-class:: sphx-glr-signature
+
+    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_