Skip to content

Commit 4289fc1

Browse files
committed
Adding troubleshooting information for DELF code
1 parent 7f5bdcd commit 4289fc1

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

research/delf/EXTRACTION_MATCHING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,13 @@ python match_images.py \
5555
The image `matched_images.png` is generated and should look similar to this one:
5656

5757
![MatchedImagesExample](delf/python/examples/matched_images_example.png)
58+
59+
### Troubleshooting
60+
61+
#### `matplotlib`
62+
63+
`matplotlib` may complain with a message such as `no display name and no
64+
$DISPLAY environment variable`. To fix this, one option is add the line
65+
`backend : Agg` to the file `config/matplotlib/matplotlibrc`. On this problem,
66+
see the discussion
67+
[here](https://stackoverflow.com/questions/37604289/tkinter-tclerror-no-display-name-and-no-display-environment-variable).

research/delf/INSTALL_INSTRUCTIONS.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,18 @@ python -c 'import delf'
8181

8282
should just return without complaints. This indicates that the DELF package is
8383
loaded successfully.
84+
85+
### Troubleshooting
86+
87+
#### Python version
88+
89+
Installation issues may happen if multiple python versions are mixed. The
90+
instructions above assume python2.7 version is used; if using python3.X, be sure
91+
to use `pip3` instead of `pip`, and all should work.
92+
93+
#### `pip install`
94+
95+
Issues might be observed if using `pip install` with `-e` option (editable
96+
mode). You may try out to simply remove the `-e` from the commands above. Also,
97+
depending on your machine setup, you might need to run the `pip install` command
98+
without `sudo` at the beginning.

0 commit comments

Comments
 (0)