From 2800f6796e2da9792788e2ebf67fb6907465a02e Mon Sep 17 00:00:00 2001
From: MLDataAnalytics <128093454+MLDataAnalytics@users.noreply.github.com>
Date: Tue, 10 Sep 2024 09:47:27 -0400
Subject: [PATCH] Update README.rst
---
README.rst | 29 ++++++++++++++++++++---------
1 file changed, 20 insertions(+), 9 deletions(-)
diff --git a/README.rst b/README.rst
index f943a69..f6cee57 100644
--- a/README.rst
+++ b/README.rst
@@ -32,10 +32,10 @@ cognition `__, and
brain `__.
.. figure::
- https://github.com/user-attachments/assets/b45d02a1-2c82-43b5-b7d5-42fc38a7b298
- :alt: image
+ https://github.com/user-attachments/assets/25809dc1-7757-48d0-8d69-c6a23164941b
+ :alt: pnet_image
- image
+ pnet_image
Getting started
---------------
@@ -43,7 +43,9 @@ Getting started
Follow the Installation Instructions to install pNet, and then check out
the `APIs `__ and
`Examples `__
-to learn how to get up and running!
+to learn how to get up and running! For visualization issues that might
+be caused by VTK, please check
+`TrobubleShooting `__.
Run with a docker image
~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,19 +64,16 @@ or
docker run mldataanalytics/fmripnet -h
-
Run with a singularity (`SingularityCE `__) image
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
::
singularity pull --arch amd64 library://yongfan/collection/fmripnet:latest
-
::
- singularity run fmripnet_latest.sif -h
-
+ singularity run fmripnet_latest.sif -h
Download and install pNet
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -362,6 +361,18 @@ References
Anal**. 2023 Apr;85:102756. doi: 10.1016/j.media.2023.102756. Epub
2023 Jan 21. PMID: 36706636; PMCID: PMC10103143.
+Troubleshooting
+---------------
+
+If vtk-osmesa (off-screen MESA) cannot be installed with conda (conda
+install -c conda-forge “vtk>=9.2=\ *osmesa*”), please have a try with
+pip (a solution provided by
+`albertleemon `__):
+
+::
+
+ pip install --extra-index-url https://wheels.vtk.org vtk-osmesa
+
Support
-------