Skip to content

Commit a5a6b3e

Browse files
committed
Update development installation instructions
1 parent dcc23d5 commit a5a6b3e

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ cd ../..
6363

6464
# execute notebook convert and store in docs directiory this step depends on successful test run
6565
jupyter nbconvert --to markdown --execute --output_dir docs/source/examples/CASE_STUDY case_studies/CASE_STUDY/scripts/example_1.ipynb
66-
6766
# repeat last step for 2nd example, ...
67+
```
6868

6969

7070

docs/source/user_guide/installation.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,21 @@ Other available backends are listed in {ref}`inference-backends`
77

88
## Development
99

10-
Development versions can be installed with `pip install pymob[dev]`
10+
If you want to develop `pymob`, clone the repository and install pymob as an editable package
1111

12-
Pymob is under active development. It is used and developed within multiple projects simultaneously and in order to maintain a consistent release history, the main work is done in project-branches which contain the most cutting-edge features. These can always checked out locally, but may not be working correctly. Instead, it is recommended to install alpha-versions.
12+
```bash
13+
git clone [email protected]:flo-schu/pymob.git
14+
cd pymob
15+
conda create -n pymob python=3.11
16+
pip install -e .[dev,docs]
17+
pre-commit install
18+
```
19+
20+
Further inference backends may be installed with `pip install -e .[numpyro,pyabc,pymoo,interactive]`
21+
22+
## Pre-release versions
23+
24+
Pymob is under active development. It is used and developed within multiple projects simultaneously and in order to maintain a consistent release history, the main work is done in project-branches which contain the most cutting-edge features. These can always checked out locally, but may not be working correctly. Instead, it is recommended to install or checkout alpha-versions.
1325

1426
E.g. `pip install pymob==0.3.0a5` which is the 5th alpha release of a project branch that was based on pymob v0.2.x.
1527

0 commit comments

Comments
 (0)