Skip to content

Commit c7efdec

Browse files
committed
minor: small improvements in doc about installation
1 parent 21b2e47 commit c7efdec

3 files changed

Lines changed: 27 additions & 22 deletions

File tree

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -107,33 +107,37 @@ This repository is organized as follows:
107107
## Getting started
108108
You need **Python 3.10 or greater**.
109109

110-
#### From Conda
110+
#### From PyPI
111+
To get the most out of PyProximal straight out of the box, we recommend using
112+
the PyPI distribution via `uv`:
111113

112-
To get the most out of PyLops straight out of the box, we recommend `conda` to install PyLops:
113114
```bash
114-
conda install -c conda-forge pyproximal
115+
uv pip install pyproximal
115116
```
116117

117-
#### From PyPI
118-
You can also install pyproximal with `pip`:
118+
or directly via `pip`:
119+
119120
```bash
120121
pip install pyproximal
121122
```
122-
or via `uv`:
123+
124+
#### From Conda
125+
You can also install PyProximal via `conda`:
126+
123127
```bash
124-
uv pip install pyproximal
128+
conda install -c conda-forge pyproximal
125129
```
126130

127131
#### From Github
128-
Finally, you can also directly install from the main branch (although this is not recommended):
132+
Finally, you can also directly install from the main branch (although this is not recommended) via `uv`:
129133

130-
```
131-
pip install git+https://git@github.com/PyLops/pyproximal.git@main
132-
```
133-
or via `uv`:
134134
```bash
135135
uv add git+https://github.com/PyLops/pyproximal.git --branch main
136136
```
137+
or via `pip`:
138+
```bash
139+
pip install git+https://git@github.com/PyLops/pyproximal.git@main
140+
```
137141

138142
## Contributing
139143
*Feel like contributing to the project? Adding new operators or tutorial?*
@@ -150,8 +154,8 @@ Execute the following command in your terminal:
150154
git clone https://github.com/your_name_here/pyproximal.git
151155
```
152156

153-
### 2. Install PyLops in a new Conda environment
154-
To ensure that further development of PyLops is performed within the same environment (i.e.,
157+
### 2. Install PyProximal in a new Conda environment
158+
To ensure that further development of PyProximal is performed within the same environment (i.e.,
155159
same dependencies) as that defined by ``environment-dev.yml``/``environment-dev-arm.yml`` files,
156160
we suggest to work off a new Conda enviroment.
157161

docs/source/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ will also be run as part of our CI.
113113

114114
.. tab-set::
115115

116-
.. tab-item:: conda
116+
.. tab-item:: :iconify:`devicon:anaconda` conda
117117

118118
.. code-block:: bash
119119

docs/source/installation.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,17 @@ First install `pyproximal` with your package manager of choice.
3737
3838
>> conda install --channel conda-forge pyproximal
3939
40-
Most of the dependencies (all required and some of the optional) are
41-
automatically installed for you.
40+
which installs also the *required* dependencies, if not already present
41+
in your environment.
4242

4343
.. tab-item:: :iconify:`material-icon-theme:uv` uv
4444

4545
.. code-block:: bash
4646
4747
>> uv add pyproximal
4848
49-
Only the *required* dependencies are installed. To install
50-
some of the optional dependencies, run:
49+
which installs also the *required* dependencies, if not already present
50+
in your environment. To also install the optional dependencies, run:
5151

5252
.. code-block:: bash
5353
@@ -79,7 +79,8 @@ Step-by-step installation for developers
7979

8080
Fork PyProximal
8181
===============
82-
Fork the `PyProximal repository <https://github.com/PyLops/pyproximal>`_ and clone it by executing the following in your terminal:
82+
Fork the `PyProximal repository <https://github.com/PyLops/pyproximal>`_ and clone it
83+
by executing the following in your terminal:
8384

8485
.. code-block:: bash
8586
@@ -175,8 +176,8 @@ At this point, the user must check the changes and then stage them before trying
175176

176177
Final steps
177178
===========
178-
PyProximal does not enforce the use of a linter as a pre-commit hook, but we do highly encourage using one before submitting a Pull Request.
179-
A properly configured linter (``ruff``) can be run with:
179+
PyProximal does enforce the use of a linter (``ruff``), which is run both as a pre-commit hook and as a GitHub Action.
180+
The linter can also be run locally with:
180181

181182
.. tab-set::
182183

0 commit comments

Comments
 (0)