Skip to content

Commit

Permalink
update CONTRIBUTING
Browse files Browse the repository at this point in the history
Signed-off-by: Yiyu Ni <niyiyu@uw.edu>
  • Loading branch information
niyiyu committed Apr 11, 2024
1 parent 25742df commit c91614f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@ Fork the repository, and create your local version, then follow the installation
```bash
conda create -n noisepy -y python=3.10 pip mpi4py
conda activate noisepy
python -m ipykernel install --user --name noisepy
pip install -e ".[dev,aws,mpi]"
```
It will install all of the dependencies of the package, including IPython to start a jupyter notebook (excluded otherwise to minimmize dependencies for command line deployment).

Install the Jupyter notebook and ipython kernel
```bash
pip install ipykernel notebook
python -m ipykernel install --user --name noisepy
```

Install the `pre-commit` hook:
```bash
Expand Down

0 comments on commit c91614f

Please sign in to comment.