CarlyneB commited on
Commit
6c7124b
·
1 Parent(s): 46436ba

[DOC] Readme up to date

Browse files
Files changed (1) hide show
  1. README.md +10 -0
README.md CHANGED
@@ -66,6 +66,8 @@ data/inputs_aggregated.csv
66
 
67
  Every time the app starts, it computes a fingerprint (hash) of the CSV and compares it to the last known value. If they differ, meaning the CSV has been modified, it automatically regenerates all the data files used by the application before loading. You do not need to run anything manually.
68
 
 
 
69
  There are two ways to update the data, depending on whether you are working directly on Hugging Face or on a local copy of the project:
70
 
71
  ### Option 1: Edit directly on Hugging Face (no local setup needed)
@@ -233,6 +235,10 @@ Each row represents **one resource used by one CDR method**, with the following
233
  > **Primary resources** (`Is secondary = FALSE`) are always active in the model.
234
  > **Secondary resources** (`Is secondary = TRUE`) are optional: users can toggle them on in the app.
235
 
 
 
 
 
236
  ---
237
 
238
  ## Maintenance cases
@@ -312,6 +318,8 @@ You should see `(venv)` at the start of your terminal line.
312
 
313
  **When to use:** A new carbon removal approach needs to be added to the tool.
314
 
 
 
315
  **Option 1 - On Hugging Face**
316
 
317
  1. In the Space, click **Files** → open `data/inputs_aggregated.csv` → click the pencil icon.
@@ -340,6 +348,8 @@ You should see `(venv)` at the start of your terminal line.
340
 
341
  **When to use:** A resource that doesn't exist yet needs to be used (e.g., a new type of mineral or energy).
342
 
 
 
343
  **Option 1 - On Hugging Face**
344
 
345
  1. Decide which **Resource group** the new resource belongs to. If it belongs to an existing group, use the exact same name. If it needs its own group, see Case 5.
 
66
 
67
  Every time the app starts, it computes a fingerprint (hash) of the CSV and compares it to the last known value. If they differ, meaning the CSV has been modified, it automatically regenerates all the data files used by the application before loading. You do not need to run anything manually.
68
 
69
+ **Automatic method deactivation:** if a CDR method requires resources that the user has not added in Tab 1 (Resource inputs), the method is automatically disabled in Tabs 2 (Method constraints) and 4 (Optimization). A "Why is this method disabled?" indicator is shown next to the method. This is expected behavior — no data change is needed.
70
+
71
  There are two ways to update the data, depending on whether you are working directly on Hugging Face or on a local copy of the project:
72
 
73
  ### Option 1: Edit directly on Hugging Face (no local setup needed)
 
235
  > **Primary resources** (`Is secondary = FALSE`) are always active in the model.
236
  > **Secondary resources** (`Is secondary = TRUE`) are optional: users can toggle them on in the app.
237
 
238
+ > **Naming convention — "Other" resources:** any resource whose name starts with `Other ` (capital O, followed by a space — e.g. `Other land`, `Other water`) is **hidden from the standard resource display** in Tabs 1 and 3. It still functions normally in the model and remains available as a reference group in the "Add resource" dialog. Use this convention intentionally when you want a resource to be inherited by custom user-defined batches but not shown as a standalone input row.
239
+
240
+ > **Naming convention — "Other" methods:** any CDR method whose name starts with `Other` receives special treatment in the optimizer. 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.
241
+
242
  ---
243
 
244
  ## Maintenance cases
 
318
 
319
  **When to use:** A new carbon removal approach needs to be added to the tool.
320
 
321
+ > ⚠️ **"Other" method naming:** if the method name starts with `Other` (e.g. `Other CDR`), the optimizer treats it specially — it creates one variant per custom resource batch that the user links to this method, instead of running it as a fixed method. Only use this naming if that expansion behavior is intentional. For a standard CDR method with defined resource inputs, use a name that does not start with `Other`.
322
+
323
  **Option 1 - On Hugging Face**
324
 
325
  1. In the Space, click **Files** → open `data/inputs_aggregated.csv` → click the pencil icon.
 
348
 
349
  **When to use:** A resource that doesn't exist yet needs to be used (e.g., a new type of mineral or energy).
350
 
351
+ > ⚠️ **"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.
352
+
353
  **Option 1 - On Hugging Face**
354
 
355
  1. Decide which **Resource group** the new resource belongs to. If it belongs to an existing group, use the exact same name. If it needs its own group, see Case 5.