Skip to content

Commit

Permalink
CAN-18 Update GitHub URL in README documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
tjohnson-somalogic committed May 14, 2024
1 parent a8b52b4 commit e6d5712
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 6 deletions.
15 changes: 12 additions & 3 deletions README.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,26 @@
"<a name=\"installation\"></a>\n",
"\n",
"## Installation\n",
"The easiest way to install `SomaData` is to install directly from\n",
"\n",
"The easiest way to install `SomaData` is to install directly from PyPI\n",
"\n",
"PIP:\n",
"\n",
"```bash\n",
"pip install SomaData\n",
"```\n",
"\n",
"\n",
"GitHub:\n",
"\n",
"``` bash\n",
"pip install git+https://github.com/SomaLogic/somadata.git#egg=somadata\n",
"pip install git+https://github.com/SomaLogic/Canopy.git#egg=somadata\n",
"```\n",
"\n",
"Alternatively, if you wish to develop or change the source code, you may clone the repository and install manually via:\n",
"\n",
"``` bash\n",
"git clone https://github.com/SomaLogic/somadata.git\n",
"git clone https://github.com/SomaLogic/Canopy.git\n",
"pip install -e ./somadata\n",
"```\n",
"\n",
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,26 @@ This document accompanies the Python package `somadata`, which loads the SomaLog
<a name="installation"></a>

## Installation
The easiest way to install `SomaData` is to install directly from
The easiest way to install `SomaData` is to install directly from PyPI

PIP:

```bash
pip install SomaData
```

Alternatively one can install from the GitHub repository.

GitHub:

``` bash
pip install git+https://github.com/SomaLogic/somadata.git#egg=somadata
pip install git+https://github.com/SomaLogic/Canopy.git#egg=somadata
```

Alternatively, if you wish to develop or change the source code, you may clone the repository and install manually via:

``` bash
git clone https://github.com/SomaLogic/somadata.git
git clone https://github.com/SomaLogic/Canopy.git
pip install -e ./somadata
```

Expand Down

0 comments on commit e6d5712

Please sign in to comment.