Skip to content

Commit e8d7472

Browse files
committed
updated readme
1 parent 58eeaba commit e8d7472

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PhysiPKPD
22
## Getting started...
33
### ...with a new project
4-
1. Download (or copy contents of) `get_physipkpd.py` to a local file.
4+
1. Download (or copy contents of) `get_physipkpd.py` and `helpers_for_get_and_add.py` to local files in the same directory.
55
2. Run
66
```
77
python get_physipkpd.py --dir path/to/project/dir --studio
@@ -10,7 +10,7 @@ python get_physipkpd.py --dir path/to/project/dir --studio
1010
3. Follow output for next steps
1111

1212
### ...adding PhysiPKPD to an existing project
13-
1. Download (or copy contents of) `add_physipkpd.py` to a local file.
13+
1. Download (or copy contents of) `add_physipkpd.py` and `helpers_for_get_and_add.py` to local files in the same directory.
1414
2. Run
1515
```
1616
python add_physipkpd.py path/to/project/dir --studio
@@ -74,8 +74,8 @@ To add PhysiPKPD to an existing project, take the following steps:
7474
* add `#include "../addons/PhysiPKPD/src/PhysiPKPD.h"` to the top
7575
3. In the configuration file, e.g., `config/PhysiCell_settings.xml`...
7676
* add a `PK` element to every PK substrate (`microenvironment_setup//variable`) (see [PK Templates](#pk_templates))
77-
* add a `PD` element to every `cell_definition` that will be affected by a PD substrate; add a `substrate` block within this `PD` element for each PD substrate affecting the given cell definition (see [Templates](#pd_templates))
78-
* add `S_damage` to *every* `cell_definition//custom_data` for every PD substrate `S`
77+
* add a `PD` element to every `cell_definition` that will be affected by a PD substrate; add a `substrate` block within this `PD` element for each PD substrate affecting the given cell definition (see [PD Templates](#pd_templates))
78+
* add `S_damage` to *every* `cell_definition//custom_data` for every PD substrate `S` (even those unaffected by `S` because PhysiCell requires all cells to have the same custom data)
7979
4. In `Makefile`...
8080
* add a line `PhysiPKPD_OBJECTS := PhysiPKPD_PK.o PhysiPKPD_PD.o`
8181
* add `$(PhysiPKPD_OBJECTS)` to the list of `PhysiCell_OBJECTS`
@@ -450,7 +450,7 @@ If you want these parameters to vary by cells *within* a cell type, that is not
450450
| Parameter | Description | If Missing |
451451
| :-- | :-- | :-- |
452452
| `dt` | Sets the time interval between PD updates (in minutes) | Set to `mechanics_dt` |
453-
| `precompute` $(m)$ | Boolean for precomputations | **Must be** `true` |
453+
| `precompute` | Boolean for precomputations | **Must be** `true` |
454454
<a name="tab:pd__optional_pars">
455455
<p align="center">
456456
<b>Table:</b> Optional XML elements for all PD models

0 commit comments

Comments
 (0)