Skip to content

Commit

Permalink
Update installation pip from GitHub
Browse files Browse the repository at this point in the history
Use the "zipball" method, to avoid problems if a user doesn't have git installed
  • Loading branch information
JorisVincent committed Mar 9, 2023
1 parent d687715 commit ad85f81
Showing 1 changed file with 23 additions and 4 deletions.
27 changes: 23 additions & 4 deletions docs/getting_started/installation.md
Expand Up @@ -9,20 +9,38 @@
```python
pip install stimupy
```
For now, `pip` can install directly from GitHub (the `main` branch)

For now, could do:
```python
pip install https://github.com/computational-psychology/stimupy/zipball/main
```

:::{admonition} Install a different version
:class: dropdown

From a specific branch, e.g. (`main`)[https://github.com/computational-psychology/stimupy/tree/main]:
```python
pip install https://github.com/computational-psychology/stimupy/archive/refs/heads/main.zip
```

From a specific tag, e.g. `v1.0.0`:
```python
pip install 'stimupy @ https://github.com/computational-psychology/stimupy'
pip install https://github.com/computational-psychology/stimupy/archive/tags/v1.0.0.zip
```

From a specific commit, e.g., (`9e37617`)[https://github.com/computational-psychology/stimupy/tree/9e37617]:
```python
pip install https://github.com/computational-psychology/stimupy/archive/9e37617.zip
```
:::
::::

::::{tab-item} conda-forge
::::{tab-item} conda
Surely this must also be possible...
::::

::::{tab-item} source (GitHub) {fab}`github`

::::{tab-item} source {fab}`github`

1. Clone the repository from GitHub:

Expand Down Expand Up @@ -51,6 +69,7 @@ this makes changes to files immediately usable,
rather than having to reinstall the package after every change.
:::
::::

:::::


Expand Down

0 comments on commit ad85f81

Please sign in to comment.