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

[DOCS] British spelling in README: optimizer → optimiser (conflicts)

Browse files
Files changed (1) hide show
  1. README.md +5 -5
README.md CHANGED
@@ -287,7 +287,7 @@ Each row represents **one resource used by one CDR method**, with the following
287
 
288
  > **Naming convention — "Other" methods:** any CDR method whose name starts with `Other` receives special treatment in the optimiser. Instead of appearing as a fixed method, the LP automatically creates **one variant per custom resource batch** the user adds that is linked to that method. This is intended for generic CDR pathways where the type of resource is user-defined. If you add a method using this naming convention, make sure it is intentional.
289
 
290
- > **Resource group and OR-substitutable resources:** when a CDR method has two or more **primary** resources (`Is secondary = FALSE`) that belong to the same `Resource group`, the optimizer treats them as **interchangeable (OR)**. The method can satisfy its resource need from either one, or any mix of the two, rather than requiring all of them simultaneously. Users will see a hint like *"only one of Other land, Arable land is required"* in the "Why is this method disabled?" panel. This behaviour is automatic: it is triggered purely by two active primary resources sharing the same `Resource group` for the same method. **If you add a resource to an existing group for a method that already has a primary resource in that group, you are creating an OR relationship — make sure this is intentional.** If it is not, create a new resource group instead (see Case 5).
291
 
292
  ---
293
 
@@ -400,7 +400,7 @@ You should see `(venv)` at the start of your terminal line.
400
 
401
  > ⚠️ **"Other" resource naming:** if you name the resource starting with `Other ` (capital O + space — e.g. `Other land`, `Other water`), it will be **hidden from the standard resource display** in the app. Users won't see it as a standalone input row, but it will still be available as a reference group when they use the "Add resource" dialog. Only use this prefix if you specifically want the resource to be hidden from direct input.
402
 
403
- > ⚠️ **Adding to an existing Resource group may create an OR relationship:** if the method you are adding this resource to already has a primary resource (`Is secondary = FALSE`) in the same `Resource group`, the optimizer will treat the two resources as interchangeable. See [Understanding inputs.csv](#understanding-inputscsv) for details. If this is not the intended behavior, create a new Resource group instead (Case 5).
404
 
405
  **Option 1 - On Hugging Face**
406
 
@@ -430,7 +430,7 @@ You should see `(venv)` at the start of your terminal line.
430
 
431
  ### Case 5 - Add a new resource group (new category)
432
 
433
- **When to use:** Your new resource doesn't fit any existing category. Also use this case when the new resource belongs to the same physical category as an existing one but should **not** be treated as interchangeable with it by the optimizer — keeping it in a separate group avoids the automatic OR relationship (see [Understanding inputs.csv](#understanding-inputscsv)).
434
 
435
  **Option 1 - On Hugging Face**
436
 
@@ -446,7 +446,7 @@ Same steps as Case 4, but write a **new group name** in the `Resource group` col
446
 
447
  **When to use:** You want to make a resource optional (user can enable/disable it) or make it always required.
448
 
449
- > ⚠️ **Changing a resource from optional to always active may create an OR relationship:** if you set `Is secondary` to `FALSE` for a resource, and the same method already has another primary resource (`Is secondary = FALSE`) in the same `Resource group`, the optimizer will treat the two as interchangeable. See [Understanding inputs.csv](#understanding-inputscsv) for details. If this is not intended, consider moving the resource to a different group (Case 5).
450
 
451
  **Option 1 - On Hugging Face**
452
 
@@ -527,7 +527,7 @@ Everything is in the same file, `data/ui_text.xlsx`, across three sheets:
527
  > | `tab1_inputs` | Resource inputs |
528
  > | `tab2_constraints` | Method constraints |
529
  > | `tab3_coefficients` | Resource coefficients |
530
- > | `tab4_optimization` | Portfolio generation |
531
  > | `tab5_sensitivity` | Sensitivity analysis |
532
  > A row with any other value is simply ignored.
533
 
 
287
 
288
  > **Naming convention — "Other" methods:** any CDR method whose name starts with `Other` receives special treatment in the optimiser. Instead of appearing as a fixed method, the LP automatically creates **one variant per custom resource batch** the user adds that is linked to that method. This is intended for generic CDR pathways where the type of resource is user-defined. If you add a method using this naming convention, make sure it is intentional.
289
 
290
+ > **Resource group and OR-substitutable resources:** when a CDR method has two or more **primary** resources (`Is secondary = FALSE`) that belong to the same `Resource group`, the optimiser treats them as **interchangeable (OR)**. The method can satisfy its resource need from either one, or any mix of the two, rather than requiring all of them simultaneously. Users will see a hint like *"only one of Other land, Arable land is required"* in the "Why is this method disabled?" panel. This behaviour is automatic: it is triggered purely by two active primary resources sharing the same `Resource group` for the same method. **If you add a resource to an existing group for a method that already has a primary resource in that group, you are creating an OR relationship — make sure this is intentional.** If it is not, create a new resource group instead (see Case 5).
291
 
292
  ---
293
 
 
400
 
401
  > ⚠️ **"Other" resource naming:** if you name the resource starting with `Other ` (capital O + space — e.g. `Other land`, `Other water`), it will be **hidden from the standard resource display** in the app. Users won't see it as a standalone input row, but it will still be available as a reference group when they use the "Add resource" dialog. Only use this prefix if you specifically want the resource to be hidden from direct input.
402
 
403
+ > ⚠️ **Adding to an existing Resource group may create an OR relationship:** if the method you are adding this resource to already has a primary resource (`Is secondary = FALSE`) in the same `Resource group`, the optimiser will treat the two resources as interchangeable. See [Understanding inputs.csv](#understanding-inputscsv) for details. If this is not the intended behavior, create a new Resource group instead (Case 5).
404
 
405
  **Option 1 - On Hugging Face**
406
 
 
430
 
431
  ### Case 5 - Add a new resource group (new category)
432
 
433
+ **When to use:** Your new resource doesn't fit any existing category. Also use this case when the new resource belongs to the same physical category as an existing one but should **not** be treated as interchangeable with it by the optimiser — keeping it in a separate group avoids the automatic OR relationship (see [Understanding inputs.csv](#understanding-inputscsv)).
434
 
435
  **Option 1 - On Hugging Face**
436
 
 
446
 
447
  **When to use:** You want to make a resource optional (user can enable/disable it) or make it always required.
448
 
449
+ > ⚠️ **Changing a resource from optional to always active may create an OR relationship:** if you set `Is secondary` to `FALSE` for a resource, and the same method already has another primary resource (`Is secondary = FALSE`) in the same `Resource group`, the optimiser will treat the two as interchangeable. See [Understanding inputs.csv](#understanding-inputscsv) for details. If this is not intended, consider moving the resource to a different group (Case 5).
450
 
451
  **Option 1 - On Hugging Face**
452
 
 
527
  > | `tab1_inputs` | Resource inputs |
528
  > | `tab2_constraints` | Method constraints |
529
  > | `tab3_coefficients` | Resource coefficients |
530
+ > | `tab4_optimisation` | Portfolio generation |
531
  > | `tab5_sensitivity` | Sensitivity analysis |
532
  > A row with any other value is simply ignored.
533