Skip to content

Commit

Permalink
updated docs - installation problems (pylibtiff)
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonMolinsky committed Feb 5, 2025
1 parent a465c5b commit 27c4659
Show file tree
Hide file tree
Showing 9 changed files with 97 additions and 1 deletion.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,29 @@ pip install pyinterpolate

A world of advice, you should **always** use Virtual Environment for the installation. You may consider using PipEnv too.

#### Known installation problems (current release)

With installation on a fresh Linux distribution you might encounter problems with `pylibtiff` which is a dependency of `pyinterpolate`.
You will get a long error message. The last line of the message is:

```shell
ERROR: ERROR: Failed to build installable wheels for some pyproject.toml based projects (pylibtiff)
```

This means that you haven't configured required system libraries yet. You should install those three libraries:

- `libtiff-dev`
- `python3-dev`
- `gcc`

Install those using command:

```shell
sudo apt install gcc python3-dev libtiff-dev
```

and after installation you should be able to install `pyinterpolate` without problems.

## Tests and contribution

All tests are grouped in the `test` directory. If you would like to contribute, then you won't avoid testing, but it is described step-by-step here: [CONTRIBUTION.md](https://github.com/DataverseLabs/pyinterpolate/blob/main/CONTRIBUTION.md)
Expand Down
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/setup/setup.doctree
Binary file not shown.
Binary file not shown.
26 changes: 26 additions & 0 deletions docs/build/html/_sources/setup/setup.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,32 @@ Now you are able to run library from a notebook.

----

Failing pylibtiff build - Linux
...............................

With installation on a fresh Linux distribution you might encounter problems with `pylibtiff` which is a dependency of `pyinterpolate`.
You will get a long error message. The last line of the message is:

.. code-block:: console
ERROR: ERROR: Failed to build installable wheels for some pyproject.toml based projects (pylibtiff)
This means that you haven't configured required system libraries yet. You should install those three libraries:

- `libtiff-dev`
- `python3-dev`
- `gcc`

Install those using command:

.. code-block:: console
sudo apt install gcc python3-dev libtiff-dev
and after installation you should be able to install `pyinterpolate` without problems.

----

The libspatialindex_c.so dependency error
.........................................

Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions docs/build/html/setup/setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,26 @@ <h3>Working with Notebooks<a class="headerlink" href="#working-with-notebooks" t
<p>Now you are able to run library from a notebook.</p>
</section>
<hr class="docutils" />
<section id="failing-pylibtiff-build-linux">
<h3>Failing pylibtiff build - Linux<a class="headerlink" href="#failing-pylibtiff-build-linux" title="Link to this heading">#</a></h3>
<p>With installation on a fresh Linux distribution you might encounter problems with <cite>pylibtiff</cite> which is a dependency of <cite>pyinterpolate</cite>.
You will get a long error message. The last line of the message is:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">ERROR: ERROR: Failed to build installable wheels for some pyproject.toml based projects (pylibtiff)</span>
</pre></div>
</div>
<p>This means that you haven’t configured required system libraries yet. You should install those three libraries:</p>
<ul class="simple">
<li><p><cite>libtiff-dev</cite></p></li>
<li><p><cite>python3-dev</cite></p></li>
<li><p><cite>gcc</cite></p></li>
</ul>
<p>Install those using command:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">sudo apt install gcc python3-dev libtiff-dev</span>
</pre></div>
</div>
<p>and after installation you should be able to install <cite>pyinterpolate</cite> without problems.</p>
</section>
<hr class="docutils" />
<section id="the-libspatialindex-c-so-dependency-error">
<h3>The libspatialindex_c.so dependency error<a class="headerlink" href="#the-libspatialindex-c-so-dependency-error" title="Link to this heading">#</a></h3>
<p>With Python==3.7 installation <cite>rtree</cite> and <cite>GeoPandas</cite> that are requirements for pyinterpolate may be not installed properly
Expand Down Expand Up @@ -526,6 +546,7 @@ <h3>The libspatialindex_c.so dependency error<a class="headerlink" href="#the-li
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#installation-additional-topics">Installation - additional topics</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#working-with-notebooks">Working with Notebooks</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#failing-pylibtiff-build-linux">Failing pylibtiff build - Linux</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#the-libspatialindex-c-so-dependency-error">The libspatialindex_c.so dependency error</a></li>
</ul>
</li>
Expand Down
26 changes: 26 additions & 0 deletions docs/source/setup/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,32 @@ Now you are able to run library from a notebook.

----

Failing pylibtiff build - Linux
...............................

With installation on a fresh Linux distribution you might encounter problems with `pylibtiff` which is a dependency of `pyinterpolate`.
You will get a long error message. The last line of the message is:

.. code-block:: console
ERROR: ERROR: Failed to build installable wheels for some pyproject.toml based projects (pylibtiff)
This means that you haven't configured required system libraries yet. You should install those three libraries:

- `libtiff-dev`
- `python3-dev`
- `gcc`

Install those using command:

.. code-block:: console
sudo apt install gcc python3-dev libtiff-dev
and after installation you should be able to install `pyinterpolate` without problems.

----

The libspatialindex_c.so dependency error
.........................................

Expand Down

0 comments on commit 27c4659

Please sign in to comment.