@hestia-earth/guide 0.0.10 → 0.0.11

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.11](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.10...v0.0.11) (2025-04-03)
+
+
+### Features
+
+* automatically include markdown files from models added to TOC ([a44d6ee](https://gitlab.com/hestia-earth/hestia-guide/commit/a44d6ee7c3625bd4c13c3594091fe9e5873665da))
+* include all models ([d712874](https://gitlab.com/hestia-earth/hestia-guide/commit/d71287420722f22c7c54c64176d6b11c4225c128))
+* **models:** nest models under their folder ([8760fb1](https://gitlab.com/hestia-earth/hestia-guide/commit/8760fb15f32b51e7306c44c7836dcf6071654a34))
+
+
+### Bug Fixes
+
+* remove incorrect entries in models ([3acd812](https://gitlab.com/hestia-earth/hestia-guide/commit/3acd8125130965f8c5623cc09e2f385a3bd16b13))
+
 ### [0.0.10](https://gitlab.com/hestia-earth/hestia-guide/compare/v0.0.9...v0.0.10) (2024-10-30)
 
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 Harmonised Environmental Storage and Tracking of the Impacts of Agriculture (HESTIA) Project
+Copyright (c) 2019-2025 Harmonised Environmental Storage and Tracking of the Impacts of Agriculture (HESTIA) Project
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -13,25 +13,27 @@ Note: only lower chars, dashes (`-`) and numbers are allowed in the filenames.
 ## Writing Guidelines
 
 1. Create a new file under `src/content` and make sure the filename only uses lowercase letters, numbers and dashes.
+1. Add the file to the `src/index.yaml` file, defining the structure of the menu.
 1. Start the file with a header level 2 using a double `##`. Example:
+    ```markdown
+    ## This is the header
 
-```markdown
-## This is the header
-
-This is the content.
+    This is the content.
 
-### This is a sub-header
-```
+    ### This is a sub-header
+    ``
 
 The header level 1 will be automatically used as Title for the Guide page, so please try to keep it short.
 
 The second line (omitting the blank lines) will be used as abstract.
 
-**Important**: the folder and the file name should reflect the Guide navigation structure.
+*Example*: if you are adding a page called "Signing in" under "HESTIA 101", please:
+- add `src/content/hestia-101/signin.md` file;
+- add a new entry `- id: signin` under the `pages` array for `hestia-101` in `src/index.yaml` file.
 
-Example: if you are adding a page called "Signing in" under "HESTIA 101", please add `src/content/hestia-101/3_signin.md` file. This will automatically:
+This will automatically:
 - show the page under "HESTIA 101" menu
-- show the page as item number 3 in the menu (if there are 2 pages before number `1_`, `2_` in the same folder)
+- show the page as item number N in the menu (depending on the page index in the yaml file)
 - match the page with the url `hestia-101-signin`
 - the title of the page will be used also in the menu
 
@@ -46,8 +48,8 @@ These metadata must be added at the end of the file, one per line. The list of m
 
 | Name | Can be added multiple times | Description |
 | ---- | ---- | ---- |
-| `previous` | ❌ | Link to the previous guide page (will show at the bottom) |
-| `next` | ❌ | Link to the next guide page (will show at the bottom) |
+| `author` | ❌ | Name of the person that wrote the file |
+| `contributor` | ✅ | Name of the person that contributed to write the file |
 | `tag` | ✅ | Used to group pages together as "related" |
 
 **Example:**
@@ -59,8 +61,6 @@ This is the content of the page.
 
 /tag ~Hestia~
 /tag ~Beginners~
-/previous ~how-to-upload~
-/next ~how-to-access-data~
 ```
 
 ### Adding images or videos
@@ -68,14 +68,7 @@ This is the content of the page.
 To add an image or a video to a page:
 - add the file under the `src/assets` folder. Note: you can use sub-directories to organise the files.
 - make sure to use a simple name, without special characters. So only letters and numbers, dashes or underscores.
-- in the content of the page, use either
-  ```html
-  <img src="/guide-content/assets/<path to the file>" alt="Text to describe the image" height="auto">
-  ```
-  or to use videos in different formats
-  ```html
-  <video width="320" height="240" controls>
-    <source src="/guide-content/assets/<path to the file>.mp4" type="video/mp4">
-    <source src="/guide-content/assets/<path to the file>.ogg" type="video/ogg">
-  </video>
-  ```
+- in the content of the page, use:
+```markdown
+![Text to describe the image](/assets/<path_to_the_file.png|.mpg>)
+```

package/dist/content/applying-models/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Applying Models"
+}

package/dist/content/applying-models/contributing.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Contributing"
+}

package/dist/content/{models → applying-models}/faq.json

@@ -1,3 +1,4 @@
 {
+  "tags": {},
   "content": "## FAQ"
 }

package/dist/content/applying-models/introduction.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Introduction"
+}

package/dist/content/hestia-101/content.json

@@ -1,3 +1,4 @@
 {
+  "tags": {},
   "content": "## HESTIA 101"
 }

package/dist/content/index.json

@@ -6,77 +6,285 @@
         "mdPath": "hestia-101/content.md",
         "jsonPath": "hestia-101/content.json",
         "title": "HESTIA 101",
-        "createdAt": "2024-10-29T09:45:38.000Z",
-        "updatedAt": "2024-10-30T08:23:25.000Z"
+        "createdAt": "2024-10-30T08:23:25.000Z",
+        "updatedAt": "2025-02-10T14:33:04.000Z",
+        "tags": {}
       }
     },
     {
       "content": {
-        "id": "models",
-        "mdPath": "models/content.md",
-        "jsonPath": "models/content.json",
+        "id": "applying-models",
+        "mdPath": "applying-models/content.md",
+        "jsonPath": "applying-models/content.json",
         "title": "Applying Models",
-        "createdAt": "2024-10-29T09:45:38.000Z",
-        "updatedAt": "2024-10-30T08:23:25.000Z"
+        "createdAt": "2024-10-30T08:23:25.000Z",
+        "updatedAt": "2025-04-02T13:52:37.000Z",
+        "tags": {}
       },
       "pages": [
         {
           "content": {
-            "id": "models-introduction",
-            "mdPath": "models/introduction.md",
-            "jsonPath": "models/introduction.json",
+            "id": "applying-models-introduction",
+            "mdPath": "applying-models/introduction.md",
+            "jsonPath": "applying-models/introduction.json",
             "title": "Introduction",
-            "createdAt": "2024-10-29T09:45:38.000Z",
-            "updatedAt": "2024-10-30T08:23:25.000Z",
-            "tags": {
-              "next": [
-                "documentation"
-              ]
-            }
+            "createdAt": "2024-10-30T08:23:25.000Z",
+            "updatedAt": "2025-04-02T13:52:37.000Z",
+            "tags": {}
           }
         },
         {
           "content": {
-            "id": "models-documentation",
-            "mdPath": "models/documentation.md",
-            "jsonPath": "models/documentation.json",
-            "title": "Documentation",
-            "createdAt": "2024-10-29T09:45:38.000Z",
-            "updatedAt": "2024-10-30T08:23:25.000Z",
-            "tags": {
-              "previous": [
-                "introduction"
-              ],
-              "next": [
-                "contributing"
+            "id": "applying-models-contributing",
+            "mdPath": "applying-models/contributing.md",
+            "jsonPath": "applying-models/contributing.json",
+            "title": "Contributing",
+            "createdAt": "2024-10-30T08:23:25.000Z",
+            "updatedAt": "2025-04-02T13:52:37.000Z",
+            "tags": {}
+          }
+        },
+        {
+          "content": {
+            "id": "applying-models-faq",
+            "mdPath": "applying-models/faq.md",
+            "jsonPath": "applying-models/faq.json",
+            "title": "FAQ",
+            "createdAt": "2024-10-30T08:23:25.000Z",
+            "updatedAt": "2025-04-02T13:52:37.000Z",
+            "tags": {}
+          }
+        }
+      ]
+    },
+    {
+      "content": {
+        "id": "models",
+        "mdPath": "models/content.md",
+        "jsonPath": "models/content.json",
+        "title": "Models",
+        "createdAt": "2024-10-30T08:23:25.000Z",
+        "updatedAt": "2025-04-02T13:52:37.000Z",
+        "tags": {}
+      },
+      "pages": [
+        {
+          "content": {
+            "id": "models-climateMeasurements",
+            "mdPath": "models/climateMeasurements/content.md",
+            "jsonPath": "models/climateMeasurements/content.json",
+            "title": "Climate Measurements",
+            "createdAt": "2025-04-03T09:49:02.000Z",
+            "updatedAt": "2025-04-03T09:49:01.000Z",
+            "tags": {}
+          },
+          "pages": [
+            {
+              "content": {
+                "id": "models-climateMeasurements-precipitationAnnual",
+                "mdPath": "models/climateMeasurements/precipitationAnnual/content.md",
+                "jsonPath": "models/climateMeasurements/precipitationAnnual/content.json",
+                "title": "Precipitation (annual)",
+                "createdAt": "2025-04-03T09:49:02.000Z",
+                "updatedAt": "2025-04-03T09:49:01.000Z",
+                "tags": {}
+              },
+              "tabs": [
+                {
+                  "content": {
+                    "id": "models-climateMeasurements-precipitationAnnual-geospatialDatabase",
+                    "mdPath": "models/climateMeasurements/precipitationAnnual/geospatialDatabase.md",
+                    "jsonPath": "models/climateMeasurements/precipitationAnnual/geospatialDatabase.json",
+                    "title": "Must be associated with at least 1 `Cycle` that has an",
+                    "createdAt": "2025-04-03T09:49:02.000Z",
+                    "updatedAt": "2025-04-03T09:49:01.000Z",
+                    "tags": {
+                      "author": [
+                        "Guillaume Royer"
+                      ],
+                      "group": [
+                        "Climate Measurements"
+                      ],
+                      "tab": [
+                        "Geospatial Database"
+                      ],
+                      "returns": [
+                        "Measurement"
+                      ]
+                    }
+                  }
+                },
+                {
+                  "content": {
+                    "id": "models-climateMeasurements-precipitationAnnual-site",
+                    "mdPath": "models/climateMeasurements/precipitationAnnual/site.md",
+                    "jsonPath": "models/climateMeasurements/precipitationAnnual/site.json",
+                    "title": "This model computes Annual value based on Monthly values.",
+                    "createdAt": "2025-04-03T09:49:01.000Z",
+                    "updatedAt": "2025-04-03T09:49:01.000Z",
+                    "tags": {
+                      "author": [
+                        "Guillaume Royer"
+                      ],
+                      "group": [
+                        "Climate Measurements"
+                      ],
+                      "tab": [
+                        "Site"
+                      ],
+                      "returns": [
+                        "Measurement"
+                      ]
+                    }
+                  }
+                }
               ]
             }
-          }
+          ]
         },
         {
           "content": {
-            "id": "models-contributing",
-            "mdPath": "models/contributing.md",
-            "jsonPath": "models/contributing.json",
-            "title": "Contributing",
-            "createdAt": "2024-10-29T09:45:38.000Z",
-            "updatedAt": "2024-10-30T08:23:25.000Z",
-            "tags": {
-              "previous": [
-                "documentation"
+            "id": "models-landAnimalExcretaAndHousing",
+            "mdPath": "models/landAnimalExcretaAndHousing/content.md",
+            "jsonPath": "models/landAnimalExcretaAndHousing/content.json",
+            "title": "Land Animal Excreta and Housing",
+            "createdAt": "2025-04-03T09:49:02.000Z",
+            "updatedAt": "2025-04-03T09:49:01.000Z",
+            "tags": {}
+          },
+          "pages": [
+            {
+              "content": {
+                "id": "models-landAnimalExcretaAndHousing-noxToAirExcreta",
+                "mdPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/content.md",
+                "jsonPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/content.json",
+                "title": "NOx, to air, excreta",
+                "createdAt": "2025-04-03T09:49:02.000Z",
+                "updatedAt": "2025-04-03T09:49:01.000Z",
+                "tags": {}
+              },
+              "tabs": [
+                {
+                  "content": {
+                    "id": "models-landAnimalExcretaAndHousing-noxToAirExcreta-dammgen2009",
+                    "mdPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/dammgen2009.md",
+                    "jsonPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/dammgen2009.json",
+                    "title": "/author ~Guillaume Royer~",
+                    "createdAt": "2025-04-03T09:49:01.000Z",
+                    "updatedAt": "2025-04-03T09:49:01.000Z",
+                    "tags": {
+                      "author": [
+                        "Guillaume Royer"
+                      ],
+                      "contributor": [
+                        "Juan Sabuco"
+                      ],
+                      "group": [
+                        "Land Animal Excreta and Housing"
+                      ],
+                      "tab": [
+                        "Dämmgen (2009)"
+                      ],
+                      "returns": [
+                        "Emission"
+                      ]
+                    }
+                  }
+                },
+                {
+                  "content": {
+                    "id": "models-landAnimalExcretaAndHousing-noxToAirExcreta-stehfestBouwman2006",
+                    "mdPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/stehfestBouwman2006.md",
+                    "jsonPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/stehfestBouwman2006.json",
+                    "title": "/author ~Guillaume Royer~",
+                    "createdAt": "2025-04-03T09:49:01.000Z",
+                    "updatedAt": "2025-04-03T09:49:01.000Z",
+                    "tags": {
+                      "author": [
+                        "Guillaume Royer"
+                      ],
+                      "group": [
+                        "Land Animal Excreta and Housing"
+                      ],
+                      "tab": [
+                        "Stehfest Bouwman (2006)"
+                      ],
+                      "requires": [
+                        "animal"
+                      ],
+                      "returns": [
+                        "Emission"
+                      ]
+                    }
+                  }
+                },
+                {
+                  "content": {
+                    "id": "models-landAnimalExcretaAndHousing-noxToAirExcreta-stehfestBouwman2006GisImplementation",
+                    "mdPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/stehfestBouwman2006GisImplementation.md",
+                    "jsonPath": "models/landAnimalExcretaAndHousing/noxToAirExcreta/stehfestBouwman2006GisImplementation.json",
+                    "title": "/author ~Guillaume Royer~",
+                    "createdAt": "2025-04-03T09:49:01.000Z",
+                    "updatedAt": "2025-04-03T09:49:01.000Z",
+                    "tags": {
+                      "author": [
+                        "Guillaume Royer"
+                      ],
+                      "group": [
+                        "Land Animal Excreta and Housing"
+                      ],
+                      "tab": [
+                        "Stehfest Bouwman (2006) GIS Implementation"
+                      ],
+                      "requires": [
+                        "animal"
+                      ],
+                      "returns": [
+                        "Emission"
+                      ]
+                    }
+                  }
+                }
               ]
             }
-          }
+          ]
         },
         {
           "content": {
-            "id": "models-faq",
-            "mdPath": "models/faq.md",
-            "jsonPath": "models/faq.json",
-            "title": "FAQ",
-            "createdAt": "2024-10-29T09:45:38.000Z",
-            "updatedAt": "2024-10-30T08:23:25.000Z"
-          }
+            "id": "models-otherGeospatialData",
+            "mdPath": "models/otherGeospatialData/content.md",
+            "jsonPath": "models/otherGeospatialData/content.json",
+            "title": "Other Geospatial Data",
+            "createdAt": "2025-04-03T09:49:02.000Z",
+            "updatedAt": "2025-04-03T09:49:01.000Z",
+            "tags": {}
+          },
+          "pages": [
+            {
+              "content": {
+                "id": "models-otherGeospatialData-salineWater",
+                "mdPath": "models/otherGeospatialData/salineWater/content.md",
+                "jsonPath": "models/otherGeospatialData/salineWater/content.json",
+                "title": "Saline water",
+                "createdAt": "2025-04-03T09:49:01.000Z",
+                "updatedAt": "2025-04-03T09:49:01.000Z",
+                "tags": {
+                  "author": [
+                    "Guillaume Royer"
+                  ],
+                  "group": [
+                    "Other Geospatial Data"
+                  ],
+                  "tab": [
+                    "Site"
+                  ],
+                  "returns": [
+                    "Measurement"
+                  ]
+                }
+              }
+            }
+          ]
         }
       ]
     }

package/dist/content/models/climateMeasurements/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Climate Measurements"
+}

package/dist/content/models/climateMeasurements/precipitationAnnual/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Precipitation (annual)\n\nThe total annual precipitation (defined as the sum of rainfall, sleet, snow, and hail, but excluding fog, cloud, and dew), expressed in mm / year."
+}

package/dist/content/models/climateMeasurements/precipitationAnnual/geospatialDatabase.json

@@ -0,0 +1,17 @@
+{
+  "tags": {
+    "author": [
+      "Guillaume Royer"
+    ],
+    "group": [
+      "Climate Measurements"
+    ],
+    "tab": [
+      "Geospatial Database"
+    ],
+    "returns": [
+      "Measurement"
+    ]
+  },
+  "content": "Must be associated with at least 1 `Cycle` that has an\n[endDate](https://hestia.earth/schema/Cycle#endDate) after `1979-01-01` and before `2020-06-01`.\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Returns</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/precipitationAnnual\">precipitationAnnual</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodModel\">methodModel</a> with <a href=\"https://hestia.earth/term/\"></a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#startDate\">startDate</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#endDate\">endDate</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>geospatial dataset</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Requirements</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code> <strong>or</strong> <code>animal housing</code> <strong>or</strong> <code>pond</code> <strong>or</strong> <code>river or stream</code> <strong>or</strong> <code>lake</code> <strong>or</strong> <code>sea or ocean</code></li>\n<li>either:<ul>\n<li>the following fields:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#latitude\">latitude</a></li>\n<li><a href=\"https://hestia.earth/schema/Site#longitude\">longitude</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#boundary\">boundary</a></li>\n</ul>\n</li>\n<li>the following fields:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#region\">region</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=region\">region</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Lookups used</div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n</div>\n"
+}

package/dist/content/models/climateMeasurements/precipitationAnnual/site.json

@@ -0,0 +1,17 @@
+{
+  "tags": {
+    "author": [
+      "Guillaume Royer"
+    ],
+    "group": [
+      "Climate Measurements"
+    ],
+    "tab": [
+      "Site"
+    ],
+    "returns": [
+      "Measurement"
+    ]
+  },
+  "content": "This model computes Annual value based on Monthly values.\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Returns</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/precipitationAnnual\">precipitationAnnual</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodModel\">methodModel</a> with <a href=\"https://hestia.earth/term/\"></a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#startDate\">startDate</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#endDate\">endDate</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>modelled using other measurements</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Requirements</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>forest</code> <strong>or</strong> <code>other natural vegetation</code> <strong>or</strong> <code>cropland</code> <strong>or</strong> <code>glass or high accessible cover</code> <strong>or</strong> <code>permanent pasture</code> <strong>or</strong> <code>animal housing</code> <strong>or</strong> <code>pond</code> <strong>or</strong> <code>river or stream</code> <strong>or</strong> <code>lake</code> <strong>or</strong> <code>sea or ocean</code></li>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li>Data completeness assessment for id: <a href=\"https://hestia.earth/schema/Completeness#id\">term.id</a> must be <code>precipitationMonthly</code></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Lookups used</div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n</div>\n"
+}

package/dist/content/models/content.json

@@ -1,3 +1,4 @@
 {
-  "content": "## Applying Models"
+  "tags": {},
+  "content": "## Models"
 }

package/dist/content/models/landAnimalExcretaAndHousing/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Land Animal Excreta and Housing"
+}

package/dist/content/models/landAnimalExcretaAndHousing/noxToAirExcreta/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## NOx, to air, excreta\n\nNitrogen oxides emissions to air, from animal excreta."
+}

package/dist/content/models/landAnimalExcretaAndHousing/noxToAirExcreta/dammgen2009.json

@@ -0,0 +1,20 @@
+{
+  "tags": {
+    "author": [
+      "Guillaume Royer"
+    ],
+    "contributor": [
+      "Juan Sabuco"
+    ],
+    "group": [
+      "Land Animal Excreta and Housing"
+    ],
+    "tab": [
+      "Dämmgen (2009)"
+    ],
+    "returns": [
+      "Emission"
+    ]
+  },
+  "content": "\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Returns</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Emission\">Emissions</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Emission#term\">term</a> with <a href=\"https://hestia.earth/term/noxToAirExcreta\">noxToAirExcreta</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodModel\">methodModel</a> with <a href=\"https://hestia.earth/term/\"></a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodTier\">methodTier</a> with <code>tier 1</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Requirements</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Cycle\">Cycle</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Cycle#site\">site</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> with <code>cropland</code> <strong>or</strong> <code>permanent pasture</code> <strong>or</strong> <code>animal housing</code> <strong>or</strong> <code>pond</code> <strong>or</strong> <code>river or stream</code> <strong>or</strong> <code>lake</code> <strong>or</strong> <code>sea or ocean</code></li>\n</ul>\n</li>\n<li>a list of <a href=\"https://hestia.earth/schema/Cycle#inputs\">inputs</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excreta\">excreta</a></li>\n</ul>\n</li>\n<li>a list of <a href=\"https://hestia.earth/schema/Cycle#practices\">practices</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Practice#value\">value</a> and <a href=\"https://hestia.earth/schema/Practice#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excretaManagement\">excretaManagement</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n<p>This model works on the following Node type with identical requirements:</p>\n    <ul>\n<li><a href=\"https://hestia.earth/schema/Cycle\">Cycle</a></li>\n<li><a href=\"https://hestia.earth/schema/Transformation\">Transformation</a></li>\n</ul></div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Lookups used</div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/excretaManagement.csv\">excretaManagement.csv</a> -&gt; <code>EF_NO-N</code></li>\n<li><a href=\"https://hestia.earth/glossary/lookups/emission.csv\">emission.csv</a> -&gt; <code>siteTypesAllowed</code>; <code>inputTermTypesAllowed</code>; <code>typesAllowed</code></li>\n</ul>\n</div>\n  </div>\n</div>\n"
+}

package/dist/content/models/landAnimalExcretaAndHousing/noxToAirExcreta/stehfestBouwman2006.json

@@ -0,0 +1,20 @@
+{
+  "tags": {
+    "author": [
+      "Guillaume Royer"
+    ],
+    "group": [
+      "Land Animal Excreta and Housing"
+    ],
+    "tab": [
+      "Stehfest Bouwman (2006)"
+    ],
+    "requires": [
+      "animal"
+    ],
+    "returns": [
+      "Emission"
+    ]
+  },
+  "content": "\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Returns</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Emission\">Emissions</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Emission#term\">term</a> with <a href=\"https://hestia.earth/term/noxToAirExcreta\">noxToAirExcreta</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodModel\">methodModel</a> with <a href=\"https://hestia.earth/term/\"></a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodTier\">methodTier</a> with <code>tier 2</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Requirements</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Cycle\">Cycle</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Cycle#site\">site</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> with <code>cropland</code> <strong>or</strong> <code>permanent pasture</code> <strong>or</strong> <code>animal housing</code> <strong>or</strong> <code>pond</code> <strong>or</strong> <code>river or stream</code> <strong>or</strong> <code>lake</code> <strong>or</strong> <code>sea or ocean</code> and a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a> and <a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/totalNitrogenPerKgSoil\">totalNitrogenPerKgSoil</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a> and <a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/ecoClimateZone\">ecoClimateZone</a></li>\n</ul>\n</li>\n</ul>\n</li>\n<li>a list of <a href=\"https://hestia.earth/schema/Cycle#inputs\">inputs</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Input#value\">value</a> and <a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#units\">units</a> = <code>kg</code> <strong>or</strong> <code>kg N</code> and <a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excreta\">excreta</a> and a list of <a href=\"https://hestia.earth/schema/Input#properties\">properties</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Property#value\">value</a> and <a href=\"https://hestia.earth/schema/Property#term\">term</a> with <a href=\"https://hestia.earth/term/nitrogenContent\">nitrogenContent</a></li>\n</ul>\n</li>\n<li><a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excreta\">excreta</a></li>\n</ul>\n</li>\n<li>Data completeness assessment for excreta: <a href=\"https://hestia.earth/schema/Completeness#excreta\">completeness.excreta</a> must be <code>True</code></li>\n<li>a list of <a href=\"https://hestia.earth/schema/Cycle#products\">products</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Product#value\">value</a> and <a href=\"https://hestia.earth/schema/Product#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#units\">units</a> = <code>kg</code> <strong>or</strong> <code>kg N</code> and <a href=\"https://hestia.earth/schema/Product#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excreta\">excreta</a> and a list of <a href=\"https://hestia.earth/schema/Product#properties\">properties</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Property#value\">value</a> and <a href=\"https://hestia.earth/schema/Property#term\">term</a> with <a href=\"https://hestia.earth/term/nitrogenContent\">nitrogenContent</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n<p>This model works on the following Node type with identical requirements:</p>\n    <ul>\n<li><a href=\"https://hestia.earth/schema/Cycle\">Cycle</a></li>\n<li><a href=\"https://hestia.earth/schema/Transformation\">Transformation</a></li>\n</ul></div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Lookups used</div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/ecoClimateZone.csv\">ecoClimateZone.csv</a> -&gt; <code>STEHFEST_BOUWMAN_2006_NOX-N_FACTOR</code></li>\n<li><a href=\"https://hestia.earth/glossary/lookups/emission.csv\">emission.csv</a> -&gt; <code>siteTypesAllowed</code>; <code>inputTermTypesAllowed</code>; <code>typesAllowed</code></li>\n</ul>\n</div>\n  </div>\n</div>\n\n\n"
+}

package/dist/content/models/landAnimalExcretaAndHousing/noxToAirExcreta/stehfestBouwman2006GisImplementation.json

@@ -0,0 +1,20 @@
+{
+  "tags": {
+    "author": [
+      "Guillaume Royer"
+    ],
+    "group": [
+      "Land Animal Excreta and Housing"
+    ],
+    "tab": [
+      "Stehfest Bouwman (2006) GIS Implementation"
+    ],
+    "requires": [
+      "animal"
+    ],
+    "returns": [
+      "Emission"
+    ]
+  },
+  "content": "\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Returns</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Emission\">Emissions</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Emission#term\">term</a> with <a href=\"https://hestia.earth/term/noxToAirExcreta\">noxToAirExcreta</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodModel\">methodModel</a> with <a href=\"https://hestia.earth/term/\"></a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#value\">value</a></li>\n<li><a href=\"https://hestia.earth/schema/Emission#methodTier\">methodTier</a> with <code>tier 1</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Requirements</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Cycle\">Cycle</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Cycle#site\">site</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> with <code>cropland</code> <strong>or</strong> <code>permanent pasture</code> <strong>or</strong> <code>animal housing</code> <strong>or</strong> <code>pond</code> <strong>or</strong> <code>river or stream</code> <strong>or</strong> <code>lake</code> <strong>or</strong> <code>sea or ocean</code> and a <a href=\"https://hestia.earth/schema/Site#country\">country</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=region\">region</a></li>\n</ul>\n</li>\n</ul>\n</li>\n<li>a list of <a href=\"https://hestia.earth/schema/Cycle#inputs\">inputs</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Input#value\">value</a> and <a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#units\">units</a> = <code>kg</code> <strong>or</strong> <code>kg N</code> and <a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excreta\">excreta</a> and a list of <a href=\"https://hestia.earth/schema/Input#properties\">properties</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Property#value\">value</a> and <a href=\"https://hestia.earth/schema/Property#term\">term</a> with <a href=\"https://hestia.earth/term/nitrogenContent\">nitrogenContent</a></li>\n</ul>\n</li>\n<li><a href=\"https://hestia.earth/schema/Input#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excreta\">excreta</a></li>\n</ul>\n</li>\n<li>Data completeness assessment for excreta: <a href=\"https://hestia.earth/schema/Completeness#excreta\">completeness.excreta</a> must be <code>True</code></li>\n<li>a list of <a href=\"https://hestia.earth/schema/Cycle#products\">products</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Product#value\">value</a> and <a href=\"https://hestia.earth/schema/Product#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#units\">units</a> = <code>kg</code> <strong>or</strong> <code>kg N</code> and <a href=\"https://hestia.earth/schema/Product#term\">term</a> of <a href=\"https://hestia.earth/schema/Term#termType\">termType</a> = <a href=\"https://hestia.earth/glossary?termType=excreta\">excreta</a> and a list of <a href=\"https://hestia.earth/schema/Product#properties\">properties</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Property#value\">value</a> and <a href=\"https://hestia.earth/schema/Property#term\">term</a> with <a href=\"https://hestia.earth/term/nitrogenContent\">nitrogenContent</a></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n<p>This model works on the following Node type with identical requirements:</p>\n    <ul>\n<li><a href=\"https://hestia.earth/schema/Cycle\">Cycle</a></li>\n<li><a href=\"https://hestia.earth/schema/Transformation\">Transformation</a></li>\n</ul></div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Lookups used</div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/region.csv\">region.csv</a> -&gt; <code>EF_NOX</code></li>\n<li><a href=\"https://hestia.earth/glossary/lookups/emission.csv\">emission.csv</a> -&gt; <code>siteTypesAllowed</code>; <code>inputTermTypesAllowed</code>; <code>typesAllowed</code></li>\n</ul>\n</div>\n  </div>\n</div>\n\n\n"
+}

package/dist/content/models/otherGeospatialData/content.json

@@ -0,0 +1,4 @@
+{
+  "tags": {},
+  "content": "## Other Geospatial Data"
+}

package/dist/content/models/otherGeospatialData/salineWater/content.json

@@ -0,0 +1,17 @@
+{
+  "tags": {
+    "author": [
+      "Guillaume Royer"
+    ],
+    "group": [
+      "Other Geospatial Data"
+    ],
+    "tab": [
+      "Site"
+    ],
+    "returns": [
+      "Measurement"
+    ]
+  },
+  "content": "## Saline water\n\nNaturally occurring water on the Earth’s surface in seas and oceans, characterised by a high concentration (>18,000 parts per million) of dissolved salts, mostly sodium chloride.\n\n\n\n\n\n<div class=\"collapsibles\">\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Returns</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A list of <a href=\"https://hestia.earth/schema/Measurement\">Measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/salineWater\">salineWater</a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodModel\">methodModel</a> with <a href=\"https://hestia.earth/term/\"></a></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#value\">value</a> with <code>100</code></li>\n<li><a href=\"https://hestia.earth/schema/Measurement#methodClassification\">methodClassification</a> with <code>modelled using other measurements</code></li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Requirements</div>\n    <div class=\"collapsible-content\"><ul>\n<li>A <a href=\"https://hestia.earth/schema/Site\">Site</a> with:<ul>\n<li>a <a href=\"https://hestia.earth/schema/Site#siteType\">siteType</a> = <code>pond</code> <strong>or</strong> <code>river or stream</code> <strong>or</strong> <code>lake</code> <strong>or</strong> <code>sea or ocean</code></li>\n<li>a list of <a href=\"https://hestia.earth/schema/Site#measurements\">measurements</a> with:<ul>\n<li><a href=\"https://hestia.earth/schema/Measurement#term\">term</a> with <a href=\"https://hestia.earth/term/waterSalinity\">waterSalinity</a> and <a href=\"https://hestia.earth/schema/Measurement#value\">value</a> <code>&gt; 18000</code></li>\n</ul>\n</li>\n</ul>\n</li>\n</ul>\n</div>\n  </div>\n  <div class=\"collapsible-group\">\n    <div class=\"collapsible-header\">Lookups used</div>\n    <div class=\"collapsible-content\"><ul>\n<li><a href=\"https://hestia.earth/glossary/lookups/measurement.csv\">measurement.csv</a> -&gt; <code>siteTypesAllowed</code></li>\n</ul>\n</div>\n  </div>\n</div>\n"
+}

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export interface IGuideIndexPageContent {
 export interface IGuideIndexPage {
     content?: IGuideIndexPageContent;
     pages?: IGuideIndexPage[];
+    tabs?: IGuideIndexPage[];
 }
 export declare const loadIndex: () => IGuideIndexPage;
 export declare const listPages: () => IGuideIndexPageContent[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hestia-earth/guide",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Hestia Guide pages",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -8,7 +8,7 @@
     "test": "node scripts/check-content.js",
     "build": "rm -rf dist && tsc -p tsconfig.dist.json",
     "build:www": "node scripts/build.js",
-    "build:content": "rimraf content && node scripts/build-content.js && node scripts/build-index.js",
+    "build:content": "rimraf content && node scripts/build-models.js && node scripts/build-content.js && node scripts/build-index.js",
     "release": "standard-version -a",
     "postrelease": "git push origin master --follow-tags"
   },
@@ -30,12 +30,21 @@
   "devDependencies": {
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",
+    "@hestia-earth/glossary": "^0.66.0",
+    "@hestia-earth/schema": "^31.0.0",
+    "axios": "^1.8.4",
+    "camelcase": "^5.3.1",
+    "dotenv": "^16.4.7",
     "git-date-extractor": "^4.0.1",
     "husky": "^4.3.8",
+    "js-yaml": "^4.1.0",
+    "lodash.groupby": "^4.6.0",
+    "lodash.mapvalues": "^4.6.0",
+    "lodash.merge": "^4.6.2",
+    "marked": "^15.0.7",
+    "pluralize": "^8.0.0",
     "rimraf": "^6.0.1",
-    "standard-version": "^9.5.0"
-  },
-  "dependencies": {
+    "standard-version": "^9.5.0",
     "typescript": "^5.6.3"
   }
 }

package/dist/content/models/contributing.json

@@ -1,8 +0,0 @@
-{
-  "tags": {
-    "previous": [
-      "documentation"
-    ]
-  },
-  "content": "## Contributing\n\n"
-}

package/dist/content/models/documentation.json

@@ -1,11 +0,0 @@
-{
-  "tags": {
-    "previous": [
-      "introduction"
-    ],
-    "next": [
-      "contributing"
-    ]
-  },
-  "content": "## Documentation\n\n\n"
-}

package/dist/content/models/introduction.json

@@ -1,8 +0,0 @@
-{
-  "tags": {
-    "next": [
-      "documentation"
-    ]
-  },
-  "content": "## Introduction\n\n"
-}