-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update installation instructions in the README (#69)
* update install instructions to install from conda-forge * change header formats * fix formatting
- Loading branch information
1 parent
49287fa
commit fb01432
Showing
1 changed file
with
13 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,8 +6,17 @@ | |
|
||
Helpful functions used by the [CME Lab](https://www.boisestate.edu/coen-cmelab/). | ||
|
||
### Installation | ||
Installation of CME Lab Utilities requires the conda package manager. We recommend [Miniconda](https://docs.conda.io/en/latest/miniconda.html). | ||
## Installation | ||
Installation of CME Lab Utilities requires a conda package manager. We recommend [Miniconda](https://docs.conda.io/en/latest/miniconda.html). | ||
|
||
### Installing from conda-forge: | ||
1. Create a new conda environment and install cmeutils. | ||
``` | ||
conda create -n cmeutils -c conda-forge cmeutils | ||
conda activate cmeutils | ||
``` | ||
|
||
### Installing from source (for development): | ||
1. Clone this repository: | ||
``` | ||
git clone [email protected]:cmelab/cmeutils.git | ||
|
@@ -18,8 +27,7 @@ Installation of CME Lab Utilities requires the conda package manager. We recomme | |
conda env create -f environment.yml | ||
conda activate cmeutils | ||
``` | ||
3. Install this package with pip: | ||
3. Install from source with pip: | ||
``` | ||
pip install . | ||
pip install -e . | ||
``` |