Skip to content

Commit

Permalink
use the right pip
Browse files Browse the repository at this point in the history
  • Loading branch information
gbarter committed Feb 1, 2025
1 parent a50048c commit 68aebfe
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ jobs:

- name: Pip Install
run: |
'${{ steps.cp.outputs.python-path }}' -m pip install matplotlib
'${{ steps.cp.outputs.python-path }}' -m pip install -v -e .[test]
- name: Test run
Expand All @@ -44,7 +45,6 @@ jobs:
- name: Test examples
run: |
cd examples
pip install matplotlib
treon -v .
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,29 @@ To set up pCrunch for development, follow these steps:
1. Download the [Miniforge3](https://github.com/conda-forge/miniforge?tab=readme-ov-file#miniforge3) variant of Anaconda
2. Open a terminal (or the Miniforge terminal on Windows) and create a new environment for the project with the following.

conda create -n pcrunch-dev
conda config --add channels conda-forge
conda install git
git clone https://github.com/NREL/pCrunch.git
cd pCrunch
conda env create --name pcrunch-dev -f environment.yml
conda activate pcrunch-dev


3. To activate/deactivate the environment, use the following commands.

conda activate pcrunch-dev
conda deactivate pcrunch-dev

4. Install dependencies needed for running and development
4. Install additional packages for testing

conda install fatpack numpy pandas pyyaml ruamel.yaml scipy numexpr pytest treon
conda install pytest treon

4. Clone the repository:

git clone https://github.com/NREL/pCrunch.git
5. Install pCrunch as an editable package with following commands.

5. Navigate to the top level of the repository (`<path-to-pCrunch>/pCrunch/`) and install pCrunch as an editable package
with following commands.
pip install -e . -v

pip install -ev .

## Examples and Documentation

Expand Down

0 comments on commit 68aebfe

Please sign in to comment.