Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ wheels/
pip-log.txt
pip-delete-this-directory.txt

uv.lock

# Unit test / coverage reports
htmlcov/
.tox/
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ with your idea or suggestion and we'd love to discuss about it.

- Fork the repo on [GitHub](https://github.com/GeoStat-Framework/GSTools)
- Add yourself to AUTHORS.md (if you want to).
- We use [Ruff](https://github.com/psf/black) to check and format the code.
- We use [Ruff](https://github.com/astral-sh/ruff) to check and format the code.
Please use the scripts `ruff check src/gstools` and
`ruff format --diff src/gstools/` after you have written your code.
- Add some tests if possible.
Expand Down
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,20 @@ To install the latest development version via pip, see the
[documentation][doc_install_link].


### uv

GSTools can be installed via [uv][uv_link] on Linux, Mac, and Windows.
Install the package by typing the following command in a command terminal:

uv add gstools

To install the latest development version via uv, see the
[documentation][doc_install_link].
One thing to point out is that this way, the non-parallel version of GSTools
is installed. In case you want the parallel version, follow these easy
[steps][doc_install_link].


## Citation

If you are using GSTools in your publication please cite our paper:
Expand Down Expand Up @@ -415,6 +429,7 @@ You can contact us via <info@geostat-framework.org>.

[pip_link]: https://pypi.org/project/gstools
[conda_link]: https://docs.conda.io/en/latest/miniconda.html
[uv_link]: https://docs.astral.sh/uv/
[conda_forge_link]: https://github.com/conda-forge/gstools-feedstock#installing-gstools
[conda_pip]: https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html#installing-non-conda-packages
[pipiflag]: https://pip-python3.readthedocs.io/en/latest/reference/pip_install.html?highlight=i#cmdoption-i
Expand Down
18 changes: 18 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,24 @@ To get the latest development version you can install it directly from GitHub:

If something went wrong during installation, try the :code:`-I` `flag from pip <https://pip-python3.readthedocs.io/en/latest/reference/pip_install.html?highlight=i#cmdoption-i>`_.

uv
--

uv can be installed via `pip <https://docs.astral.sh/uv/>`_ on Linux, Mac,
and Windows.
Install the package by typing the following command in a command terminal:

.. code-block:: none

uv add gstools

To get the latest development version you can install it directly from GitHub:

.. code-block:: none

uv add "gstools @ git+https://github.com/GeoStat-Framework/GSTools.git"


**Running GSTools in parallel**

The number of parallel threads can be set with the global variable
Expand Down
Loading