From e6d5712753cd073154c3adddaacd4be1d5fac278 Mon Sep 17 00:00:00 2001 From: Ted Johnson Date: Tue, 14 May 2024 16:15:45 -0600 Subject: [PATCH] CAN-18 Update GitHub URL in README documentation. --- README.ipynb | 15 ++++++++++++--- README.md | 15 ++++++++++++--- 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/README.ipynb b/README.ipynb index 42b9386..cd4e5e0 100644 --- a/README.ipynb +++ b/README.ipynb @@ -44,17 +44,26 @@ "\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", diff --git a/README.md b/README.md index 6d8f24b..b897e5b 100644 --- a/README.md +++ b/README.md @@ -28,17 +28,26 @@ This document accompanies the Python package `somadata`, which loads the SomaLog ## 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 ```