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
6 changes: 4 additions & 2 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -126,6 +127,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
Expand Down
14 changes: 11 additions & 3 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -87,12 +95,12 @@ Fork the `PyLops repository <https://github.com/PyLops/pylops>`_ 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
Expand Down
Loading