Skip to content

docs: developer installation #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2024
Merged

docs: developer installation #246

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/getting_started/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,10 @@ We recommend using ``conda`` to install the development environment. ::
cd pycsep
conda env create -f requirements.yml
conda activate csep-dev
pip install -e .
pip install -e .[all]
# Allow sync with default repository
git remote add upstream https://github.com/SCECCode/pycsep.git

This ensures to have a clean installation of ``pyCSEP`` and the required developer dependencies (e.g., ``pytest``, ``sphinx``).
Now you can pull from upstream using ``git pull upstream master`` to keep your copy of the repository in sync with the
latest commits.