diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index f20583a..c48414e 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -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 @@ -44,7 +45,6 @@ jobs: - name: Test examples run: | cd examples - pip install matplotlib treon -v . diff --git a/README.md b/README.md index 808f870..9d082dd 100644 --- a/README.md +++ b/README.md @@ -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 (`/pCrunch/`) and install pCrunch as an editable package - with following commands. + pip install -e . -v - pip install -ev . ## Examples and Documentation