diff --git a/.gitignore b/.gitignore index 02e1d173..7723349a 100644 --- a/.gitignore +++ b/.gitignore @@ -35,6 +35,8 @@ wheels/ pip-log.txt pip-delete-this-directory.txt +uv.lock + # Unit test / coverage reports htmlcov/ .tox/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 60359004..2fbe8329 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 067136a7..e1975dcb 100644 --- a/README.md +++ b/README.md @@ -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: @@ -415,6 +429,7 @@ You can contact us via . [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 diff --git a/docs/source/index.rst b/docs/source/index.rst index d877e944..4f346d15 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 `_. +uv +-- + +uv can be installed via `pip `_ 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