Skip to content

Commit c9d40b8

Browse files
committed
Update install instructions to use recurse submodule and pip install with quotes
1 parent 5bd64eb commit c9d40b8

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,12 @@ or **Miniconda**
7070
page. This creates a copy of the code under your account on github.
7171
3. Clone this copy to your local disk
7272

73-
git clone https://github.com:YourLogin/pyElli.git
73+
git clone --recurse-submodules https://github.com/PyEllips/pyElli
7474
cd pyElli
7575

7676
4. You should run
7777

78-
pip install -U pip setuptools -e .[fitting,dev]
78+
pip install -e ".[fitting,dev]"
7979

8080
which installs the package in development mode and all extra requirements in your current virtualenv.
8181

docs/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To install the package in your current virtual environment execute
1010

1111
.. code-block:: shell
1212
13-
pip install pyElli[fitting]
13+
pip install "pyElli[fitting]"
1414
1515
This installs pyElli with the additional fitting capabilities and interactive widgets.
1616
If you don't want to have this functionality just drop the `[fitting]` in the end.
@@ -44,6 +44,6 @@ the folder to install it in development mode:
4444

4545
.. code-block:: shell
4646
47-
git clone https://github.com/PyEllips/pyElli
47+
git clone --recurse-submodules https://github.com/PyEllips/pyElli
4848
cd pyElli
4949
pip install -e .

0 commit comments

Comments
 (0)