Skip to content

Fix install instructions and git clone with submodule #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 7, 2025
Merged

Fix install instructions and git clone with submodule #217

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bd64eb
Fix install instructions in README
domna Aug 6, 2025
c9d40b8
Update install instructions to use recurse submodule and pip install …
domna Aug 6, 2025
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
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,12 @@ or **Miniconda**
page. This creates a copy of the code under your account on github.
3. Clone this copy to your local disk

git clone https://github.com:YourLogin/pyElli.git
git clone --recurse-submodules https://github.com/PyEllips/pyElli
cd pyElli

4. You should run

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

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

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The installers for all releases are available at the [Python Package Index (PyPI
To install run:

```sh
pip install pyElli[fitting]
pip install "pyElli[fitting]"
```

This installs pyElli with the additional fitting capabilities and interactive widgets.
Expand Down Expand Up @@ -66,7 +66,7 @@ The source code is hosted on [GitHub](https://github.com/PyEllips/pyElli), to ma
the folder to install it in development mode:

```sh
git clone https://github.com/PyEllips/pyElli
git clone --recurse-submodules https://github.com/PyEllips/pyElli
cd pyElli
pip install -e ".[fitting]"
```
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To install the package in your current virtual environment execute

.. code-block:: shell

pip install pyElli[fitting]
pip install "pyElli[fitting]"

This installs pyElli with the additional fitting capabilities and interactive widgets.
If you don't want to have this functionality just drop the `[fitting]` in the end.
Expand Down Expand Up @@ -44,6 +44,6 @@ the folder to install it in development mode:

.. code-block:: shell

git clone https://github.com/PyEllips/pyElli
git clone --recurse-submodules https://github.com/PyEllips/pyElli
cd pyElli
pip install -e .