From c783a1debe64cd247c93322618128add2cf312cd Mon Sep 17 00:00:00 2001 From: Philip Loche Date: Wed, 6 Dec 2023 18:37:45 +0100 Subject: [PATCH 1/2] Fix link to Python's `list` documentation --- examples/library-tutorial.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/library-tutorial.py b/examples/library-tutorial.py index 6d84ab57..51ac0811 100644 --- a/examples/library-tutorial.py +++ b/examples/library-tutorial.py @@ -49,7 +49,7 @@ def sliceplot(mesh, sz=12, cmap="viridis", vmin=None, vmax=None): # -------------------- # # Builds a CsCl structure by replicating the primitive cell using ase and convert it to -# a :py:class:`List` of :py:class:`meshlode.System`. We add a bit of noise to make +# a :py:class:`list` of :py:class:`meshlode.System`. We add a bit of noise to make # it less boring! # From 74a515aa5a96d4bf51cc5d7bb0db224fa64d17b3 Mon Sep 17 00:00:00 2001 From: Philip Loche Date: Wed, 6 Dec 2023 18:40:16 +0100 Subject: [PATCH 2/2] Show installation instructions in documentation --- README.rst | 10 +++++++++- docs/src/index.rst | 1 + docs/src/installation.rst | 3 +++ 3 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 docs/src/installation.rst diff --git a/README.rst b/README.rst index 42dd472e..60956b1f 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,15 @@ You can install *MeshLode* using pip with cd MeshLODE pip install . -You can then `import meshlode` and use it in your projects! +You can then ``import meshlode`` and use it in your projects! + +We also provide bindings to `metatensor +`_ which can enable as an optional +dependencies via + +.. code-block:: bash + + pip install .[metatensor] .. marker-issues diff --git a/docs/src/index.rst b/docs/src/index.rst index dcf87e34..c83141ce 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -6,5 +6,6 @@ Particle-mesh based calculation of Long Distance Equivariants. .. toctree:: :hidden: + installation examples/index references/index diff --git a/docs/src/installation.rst b/docs/src/installation.rst new file mode 100644 index 00000000..1c9bbf37 --- /dev/null +++ b/docs/src/installation.rst @@ -0,0 +1,3 @@ +.. include:: ../../README.rst + :start-after: marker-installation + :end-before: marker-issues