Skip to content

Commit 2604cfd

Browse files
authored
Merge pull request #691 from mrava87/doc-projstruct
Doc: project structure
2 parents 67ff814 + ca4f9b5 commit 2604cfd

2 files changed

Lines changed: 15 additions & 5 deletions

File tree

docs/source/contributing.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,9 @@ Ready to contribute?
6868
6969
Now you can make your changes locally.
7070

71-
3. When you're done making changes, check that your code follows the guidelines for :ref:`addingoperator` and
72-
that the both old and new tests pass successfully:
71+
3. When you're done making changes, check that your code follows the guidelines for
72+
:ref:`addingoperator` or :ref:`addingsolver` and that both old and new tests pass
73+
successfully:
7374

7475
.. code-block:: bash
7576
@@ -126,6 +127,7 @@ Before you submit a pull request, check that it meets these guidelines:
126127
Project structure
127128
#################
128129
This repository is organized as follows:
130+
129131
* **pylops**: Python library containing various linear operators and auxiliary routines
130132
* **pytests**: set of pytests
131133
* **testdata**: sample datasets used in pytests and documentation

docs/source/installation.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ to install the PyPI distribution:
5252
5353
Note that when installing via ``pip``, only *required* dependencies are installed.
5454

55+
From Source
56+
===========
57+
To access the latest source from github:
58+
59+
.. code-block:: bash
60+
61+
>> pip install https://github.com/PyLops/pylops.git@dev
62+
5563
Docker
5664
======
5765
If you want to try PyLops but do not have Python in your
@@ -87,12 +95,12 @@ Fork the `PyLops repository <https://github.com/PyLops/pylops>`_ and clone it by
8795
8896
>> git clone https://github.com/YOUR-USERNAME/pylops.git
8997
90-
We recommend installing dependencies into a separate environment.
91-
For that end, we provide a `Makefile` with useful commands for setting up the environment.
92-
9398
Install dependencies
9499
====================
95100

101+
We recommend installing dependencies into a separate environment.
102+
For that end, we provide a `Makefile` with useful commands for setting up the environment.
103+
96104
Conda (recommended)
97105
-------------------
98106
For a ``conda`` environment, run

0 commit comments

Comments
 (0)