From 97e32bd4fba4dae04809736d3bd265551bc9dcc7 Mon Sep 17 00:00:00 2001 From: AlainKadar Date: Wed, 10 Apr 2024 14:04:11 -0400 Subject: [PATCH] Add link to installation --- README.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index aec021b..a55dd4f 100644 --- a/README.rst +++ b/README.rst @@ -6,10 +6,13 @@ Overview ======== A python package for the extraction and analysis of graphs from 2D and 3D experimental micrographs. Image processing techniques taken from `StructuralGT `__. -Use -=== -To use, clone, build, and install from the `GitHub repository -`__. You will need to install the cython, igraph, and eigen with conda. +Installation +============ +StructuralGT is easiest to from source, using conda to link dependencies. +To do so, clone, build, +and install from the `GitHub repository +`__. +You will need to install the cython, igraph, and eigen. .. code:: bash @@ -18,6 +21,9 @@ To use, clone, build, and install from the `GitHub repository cd StructuralGT python setup.py install +A conda installation streamlines linking the required dependencies. To avoid +using conda, please see :ref:`installation-label` for a more customized installation. + Example ======= The following minimal example shows how the package can be used to calculate the graph theoretic parameters of a 3D structural nanofibre network: