CarlyneB commited on
Commit
2601bda
·
1 Parent(s): 1e21d3a

[DOCS] Example Afforestation -> Afforestation/reforestation + Warning case 2 OR relationship between same 'Resource group'

Browse files
Files changed (1) hide show
  1. README.md +5 -3
README.md CHANGED
@@ -212,7 +212,7 @@ The app detects that the CSV has changed and automatically runs the update scrip
212
  In the terminal:
213
  ```
214
  git add -A -- ':!venv/'
215
- git commit -m "Your description here (e.g. Update coefficients for Afforestation)"
216
  git push
217
  ```
218
 
@@ -269,7 +269,7 @@ Each row represents **one resource used by one CDR method**, with the following
269
 
270
  | Column | Description | Example |
271
  |--------|-------------|---------|
272
- | `Implementation` | Name of the CDR method | `Afforestation` |
273
  | `Method group` | Category the method belongs to | `Forestry` |
274
  | `Resource` | Name of the resource used | `Other land` |
275
  | `Resource group` | Category the resource belongs to | `Land` |
@@ -342,7 +342,9 @@ You should see `(venv)` at the start of your terminal line.
342
 
343
  ### Case 2 - Add an existing resource to an existing method
344
 
345
- **When to use:** A CDR method should now also use a resource that is already tracked for other methods (e.g., water is already listed for other methods, and you want to add it to Afforestation too). If the resource doesn't exist at all yet, use Case 4 first.
 
 
346
 
347
  **Option 1 - On Hugging Face**
348
 
 
212
  In the terminal:
213
  ```
214
  git add -A -- ':!venv/'
215
+ git commit -m "Your description here (e.g. Update coefficients for Afforestation/reforestation)"
216
  git push
217
  ```
218
 
 
269
 
270
  | Column | Description | Example |
271
  |--------|-------------|---------|
272
+ | `Implementation` | Name of the CDR method | `Afforestation/reforestation` |
273
  | `Method group` | Category the method belongs to | `Forestry` |
274
  | `Resource` | Name of the resource used | `Other land` |
275
  | `Resource group` | Category the resource belongs to | `Land` |
 
342
 
343
  ### Case 2 - Add an existing resource to an existing method
344
 
345
+ **When to use:** A CDR method should now also use a resource that is already tracked for other methods (e.g., water is already listed for other methods, and you want to add it to Afforestation/reforestation too). If the resource doesn't exist at all yet, use Case 4 first.
346
+
347
+ > ⚠️ **This may create an OR relationship:** if the method already has another primary resource (`Is secondary = FALSE`) in the same `Resource group` as the one you're adding, the optimiser will treat the two as interchangeable (the method can run on either one, not both). See [Understanding inputs.csv](#understanding-inputscsv) for details. If this is not the intended behavior, use a different `Resource group` for the new row (Case 5), or mark it `Is secondary = TRUE`.
348
 
349
  **Option 1 - On Hugging Face**
350