Skip to content

Commit

Permalink
Add link to installation
Browse files Browse the repository at this point in the history
  • Loading branch information
AlainKadar committed Apr 10, 2024
1 parent f575843 commit 97e32bd
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/drewvecchio/StructuralGT>`__.

Use
===
To use, clone, build, and install from the `GitHub repository
<https://github.com/AlainKadar/StructuralGT>`__. 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
<https://github.com/AlainKadar/StructuralGT>`__.
You will need to install the cython, igraph, and eigen.

.. code:: bash
Expand All @@ -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:
Expand Down

0 comments on commit 97e32bd

Please sign in to comment.