Skip to content

Commit 2792554

Browse files
committed
Add install instructions for developerse
1 parent cbfdc9f commit 2792554

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/source/dev/contributing.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,3 +114,15 @@ Review Process
114114
Once your pull request is submitted, a member of the WATTS core development team
115115
will review your pull request. They will check your contribution against the
116116
above checklist to ensure that it is of sufficient quality.
117+
118+
Installation for Developers
119+
+++++++++++++++++++++++++++
120+
121+
As a developer, it is advisable to install WATTS from the local source tree in
122+
"`editable <https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs>`_"
123+
mode::
124+
125+
pip install -e <path-to-watts-dir>
126+
127+
This will install the package via a link to the original location so that any
128+
local changes are immediately reflected in your environment.

0 commit comments

Comments
 (0)