From 66b8969abc82d7be7f40b72818a51afddf3c3aba Mon Sep 17 00:00:00 2001 From: mrava87 Date: Tue, 26 Aug 2025 22:02:47 +0100 Subject: [PATCH 1/2] minor: fix list of project structure in contributing.rst --- docs/source/contributing.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 600eb8daf..58a57ab58 100755 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -126,6 +126,7 @@ Before you submit a pull request, check that it meets these guidelines: Project structure ################# This repository is organized as follows: + * **pylops**: Python library containing various linear operators and auxiliary routines * **pytests**: set of pytests * **testdata**: sample datasets used in pytests and documentation From ca4f9b5016a5fba6d893c7dcefea7e81c181bfb6 Mon Sep 17 00:00:00 2001 From: mrava87 Date: Tue, 26 Aug 2025 22:39:42 +0100 Subject: [PATCH 2/2] doc: small improvements to installation documentation --- docs/source/contributing.rst | 5 +++-- docs/source/installation.rst | 14 +++++++++++--- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 58a57ab58..8b8eb9d5c 100755 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -68,8 +68,9 @@ Ready to contribute? Now you can make your changes locally. -3. When you're done making changes, check that your code follows the guidelines for :ref:`addingoperator` and -that the both old and new tests pass successfully: +3. When you're done making changes, check that your code follows the guidelines for +:ref:`addingoperator` or :ref:`addingsolver` and that both old and new tests pass +successfully: .. code-block:: bash diff --git a/docs/source/installation.rst b/docs/source/installation.rst index d066856e3..9f148a125 100755 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -52,6 +52,14 @@ to install the PyPI distribution: Note that when installing via ``pip``, only *required* dependencies are installed. +From Source +=========== +To access the latest source from github: + +.. code-block:: bash + + >> pip install https://github.com/PyLops/pylops.git@dev + Docker ====== If you want to try PyLops but do not have Python in your @@ -87,12 +95,12 @@ Fork the `PyLops repository `_ and clone it by >> git clone https://github.com/YOUR-USERNAME/pylops.git -We recommend installing dependencies into a separate environment. -For that end, we provide a `Makefile` with useful commands for setting up the environment. - Install dependencies ==================== +We recommend installing dependencies into a separate environment. +For that end, we provide a `Makefile` with useful commands for setting up the environment. + Conda (recommended) ------------------- For a ``conda`` environment, run