From bd3f962867f89473bc064b7bcb8733f1eed46c12 Mon Sep 17 00:00:00 2001 From: <> Date: Sat, 20 Jan 2024 22:55:29 +0100 Subject: [PATCH] Deployed fc6c6d3 with MkDocs version: 1.5.3 --- 404.html | 23 + assets/schemas/jkum-schema-1.0.json | 306 +++++++++ examples/index.html | 926 ++++++++++++++++++++++++++++ file-structure/index.html | 560 ++++++++++++++++- getting-started/index.html | 27 +- getting-started_backup/index.html | 23 + index.html | 23 + introduction/index.html | 23 + roadmap/index.html | 23 + schemas/jkum-schema-1.0/index.html | 23 + search/search_index.json | 2 +- sitemap.xml | 21 +- sitemap.xml.gz | Bin 295 -> 304 bytes third-party-code/index.html | 91 ++- 14 files changed, 2034 insertions(+), 37 deletions(-) create mode 100755 assets/schemas/jkum-schema-1.0.json create mode 100755 examples/index.html diff --git a/404.html b/404.html index 975a2ef..f9dbebb 100755 --- a/404.html +++ b/404.html @@ -369,6 +369,8 @@ + + @@ -450,6 +452,27 @@ +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • diff --git a/assets/schemas/jkum-schema-1.0.json b/assets/schemas/jkum-schema-1.0.json new file mode 100755 index 0000000..f195f82 --- /dev/null +++ b/assets/schemas/jkum-schema-1.0.json @@ -0,0 +1,306 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema", + "$id": "http://www.vavisjon.no/jkum/jkum-schema1.0.json", + "required": [ + "head" + ], + "title": "JSON Schema for the JKUM file format", + "type": "object", + "definitions": { + "head": { + "type": "object", + "title": "The head of the JKUM file, containing relevant information about the file", + "required": [ + "epsg" + ], + "properties": { + "epsg": { + "type": "integer", + "default": "", + "examples": [ + 25832, + 25832, + 5110, + 5111 + ], + "pattern": "^[0-9]{4,5}$" + }, + "date": { + "type": "string", + "default": "", + "examples": [ + "2020-01-22" + ], + "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$" + }, + "author": { + "type": "string", + "title": "The Author Schema", + "default": "", + "examples": [ + "Hans Martin Eikerol" + ] + } + } + }, + "location": { + "type": "object", + "properties": { + "east": { "type": "number" }, + "north": { "type": "number" }, + "elevation": { "type": "number" } + }, + "required": [ "east", "north", "elevation" ] + }, + "guid": { + "type": "string", + "pattern": "^[0-9a-fA-F]{8}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{12}$", + "examples": [ + "cc984777-f7fc-475b-9f32-7cafd70a09cb" + ] + }, + "lid": { + "type": "object", + "properties": { + "guid": { + "type": [ + "string", + "null" + ] + }, + "position": { + "$ref": "#/definitions/location" + }, + "diameter": { + "$id": "#/properties/manholes/items/properties/lids/items/properties/diameter", + "type": "integer", + "examples": [ + 650 + ] + }, + "ladder": { + "type": "string", + "default": "Unspecified", + "examples": [ + "Yes" + ], + "enum": [ "Unspecified", "Yes", "No" ] + }, + "classification": { + "type": "string", + "default": "Unspecified", + "examples": [ + "D400" + ], + "enum": [ "Unspecified", "D400", "D700" ] + } + }, + "required": [ + "position", + "diameter" + ] + }, + "imageData": { + "type": "object", + "properties": { + "base64String": { + "type": "string" + }, + }, + "required": [ + "base64String" + ] + }, + "manhole": { + "type": "object", + "required": [ + "guid", + "bottomCenter", + "lids" + ], + "properties": { + "guid": { + "$ref": "#/definitions/guid" + }, + "sid": { + "type": "string", + "default": "", + "examples": [ + "556001" + ] + }, + "bottomCenter": { + "$ref": "#/definitions/location" + }, + "shape": { + "type": "string", + "default": "Circular", + "examples": [ + "Rectangular" + ], + "enum": [ "Circular", "Rectangular", "Polygon" ] + }, + "material": { + "type": "string", + "default": "Concrete", + "examples": [ + "Concrete" + ], + "enum": [ "Concrete", "Bricks", "Plastic", "Rehabilitated", "Other" ] + }, + "diameter": { + "type": "integer", + "examples": [ + 1600 + ] + }, + "width": { + "type": "integer", + "examples": [ + 1200 + ] + }, + "length": { + "type": "integer", + "examples": [ + 1600, + 1400, + 1200, + 400 + ] + }, + "lids": { + "type": "array", + "items": { + "$ref": "#/definitions/lid" + } + }, + "pipes": { + "type": "array", + "items": { + "$ref": "#/definitions/pipeConnection" + } + }, + "circumference": { + "type": "array", + "items": { + "$ref": "#/definitions/manholeCircumference" + } + }, + "imageData": { + "type": "array", + "items": { + "$ref": "#/definitions/imageData" + } + } + } + }, + "manholeCircumference": { + "type": [ + "object", + "null" + ], + "properties": { + "innerVertices": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/location" + } + }, + "outerVertices": { + "type": [ + "array", + "null" + ], + "items": { + "$ref": "#/definitions/location" + } + } + } + }, + "pipeConnection": { + "type": [ + "object", + "null" + ], + "properties": { + "guid": { + "$ref": "#/definitions/guid" + }, + "sid": { + "type": "string", + "examples": [ + "548861" + ] + }, + "medium": { + "type": "string", + "title": "The medium transported in the pipe", + "examples": [ + "Water", + "Sewer", + "Storm water", + "Drain" + ], + "enum": [ "Water", "Sewer", "Storm water", "Drain" ] + }, + "direction": { + "type": "string", + "title": "The assumed flow direction of the pipe contents", + "examples": [ + "Ingoing" + ], + "enum": [ "Ingoing", "Outgoing" ] + }, + "pressurized": { + "type": "boolean", + "default": false, + "examples": [ + false + ] + }, + "elevation": { + "type": "number", + "examples": [ + 53.11 + ] + }, + "clockPosition": { + "type": "integer", + "title": "The Clockposition Schema", + "examples": [ + 20 + ], + "pattern": "^[0-3][0-9]?[0-9]?$" + }, + "diameter": { + "type": "integer", + "examples": [ + 150 + ] + } + }, + "required": [ + "guid", + "pressurized", + "elevation", + "clockPosition", + "diameter" + ] + } + }, + "properties": { + "head": { + "$ref": "#/definitions/head" + }, + "manholes": { + "type": [ "array", "null" ], + "items": { + "$ref": "#/definitions/manhole" + } + } + } +} diff --git a/examples/index.html b/examples/index.html new file mode 100755 index 0000000..afc2fee --- /dev/null +++ b/examples/index.html @@ -0,0 +1,926 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Examples - JKUM + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + +
    + + +
    + +
    + + + + + + + + + +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + + + + + + + + + + + + + + + + +

    Examples

    +

    This page comprise a few sample files that will be counted as valid files within +the JKUM file format.

    +

    Minumum file sample

    +

    In order to generate a minimal and valid file, the JKUM-contents should be like this:

    +
    {
+  "head": {
+    "epsg": 25832,
+  },
+  "manholes": [
+    {
+      "guid": "03de0a00-d6c0-4cb4-81bd-8f6ebdfad7a6",
+      "shape": "Circular",
+      "diameter": 1600,
+      "lids": [
+        {
+          "guid": "216e1618-bdf4-4ade-8Bg9-h9BBs34df115",
+          "position": {
+            "east": 588447.155,
+            "north": 6642743.826,
+            "elevation": 55.145
+          }
+        }
+      ]
+    }
+  ]
+}
+
    + + + + + + + + + + + + + +
    +
    + + + +
    + + + +
    + + + +
    +
    +
    +
    + + + + + + + + + + \ No newline at end of file diff --git a/file-structure/index.html b/file-structure/index.html index b555ca6..c85ede7 100755 --- a/file-structure/index.html +++ b/file-structure/index.html @@ -20,7 +20,7 @@ - + @@ -382,6 +382,8 @@ + + @@ -491,12 +493,90 @@ @@ -514,6 +594,27 @@ +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • @@ -730,12 +831,90 @@ @@ -782,19 +961,360 @@

    File structure "manholes": [...] } -

    Minumum file sample

    -

    In order to generate a minimal and valid file, the JKUM-contents should be like this:

    -
    {
-  "head": {
-    "epsg": 25832
-  }
-  "manholes": [
-    {
-      "guid": 
-    }
-  ]
-}
-
    +

    Properties

    +

    The .jkum-file has two properties at the top level: head and manholes. In the following, all +related objects and properties are described.

    + +

    The head property consists of these possible properties:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    epsgintegerThe EPSG ID for the coordinate system which the coordinates this file system is represented.
    datestringAn ISO 8601-formatted date string on the format YYYY-MM-DD.
    authorstringThe name or descriptive text about the author of the file.
    +

    Manholes

    +

    The manholes-property is an array consisting of Manhole.

    +

    Manhole

    +

    The properties for manholes are listed in this table.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    guidGUIDA unique system-generated GUID for future reference and identification for the object.
    sidstringA unique ID commonly used in mapping systems. Enables a better human-readable ID for the object.
    bottomCenterLocationThe position of the centerpoint of the manhole construction at its bottom center.
    shapestringThe shape of the Manhole, one of: Circular, Rectangular or Polygon.
    lidsarray<Lid>An array of Lid objects. Contains an array of Lids, since some manholes may have more than one Lid.
    pipesarray<PipeConnection>An array of PipeConnection objects.
    imageDataarray<ImageData>An array of ImageData objects.
    +

    Depending on the shape of the manhole, the following properties are also required:

    +
    +
    +
    + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    diameterintegerThe manhole inner diameter in millimeters.
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    widthintegerThe manhole inner width in millimeters.
    lengthintegerThe manhole inner length in millimeters.
    +
    +
    + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    circumferencearrayA circumference-object consisting of the inner and outer boundary representing the Manhole constructions' shape.
    +
    +
    +
    +

    Location

    +

    The location-attribute consists of the three properties east, north and elevation.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    eastfloatA float representing the east coordinate within the EPSG-system as defined in the file head-property.
    northfloatA float representing the north coordinate within the EPSG-system as defined in the file head-property.
    elevationfloatA float representing the elevation of the coordinate within the EPSG-system as defined in the file head-property.
    +

    Circumference

    + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    innerVerticesarray<Location>An array of vertices within the EPSG-system as defined in the file head-property.
    outerVerticesarray<Location>An array of vertices within the EPSG-system as defined in the file head-property.
    +

    Lid

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    guidGUIDA unique system-generated GUID for future reference and identification for the object.
    positionLocationThe position of the center point of the lid in the terrain.
    diameterintegerThe manhole inner diameter in millimeters.
    ladderstringIf there is a ladder: Yes, otherwise No. Defaults to Unspecified in the absence of the property.
    classificationstringDetails of the lid type, one of: Unspecified, D400, D700
    +

    PipeConnection

    +

    When looking down into the manhole, pipe ends can be seen. Not knowing where the other end +of the pipe is going or coming from, this file format instead focus on the relevant +connector points that can be seen from inside the manhole.

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    guidGUIDA unique system-generated GUID for future reference and identification for the object.
    sidstringA unique ID commonly used in mapping systems. Enables a better human-readable ID for the object.
    mediumstringThe medium transported in the pipe. Must be one of the following: Water, Sewer, Storm water, Drain
    directionstringThe assumed flow direction of the pipe contents. Must be one of the following: Ingoing, Outgoing
    pressurizedbooleanIf the pipe is a pressurized system.
    elevationfloat
    clockPositioninteger
    diameterintegerThe pipe diameter in millimeters.
    +

    ImageData

    +

    The imageData-property should consist of at least one of the following data.

    + + + + + + + + + + + + + + + + + + + + + + + +
    Property NameTypeRequiredDescription
    base64StringstringA base 64 encoded string representing the image.
    imageUrlstringA valid url to the location of the file, where it should be available for download.
    @@ -847,13 +1367,13 @@

    Minumum file sample +
    Next
    - Third-party code + Examples
    diff --git a/getting-started/index.html b/getting-started/index.html index 8d2e3b3..f58ba6f 100755 --- a/getting-started/index.html +++ b/getting-started/index.html @@ -382,6 +382,8 @@ + + @@ -463,6 +465,27 @@ +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • @@ -729,8 +752,8 @@

    Getting started Yes -In progress + Yes +Completed JkumParser diff --git a/getting-started_backup/index.html b/getting-started_backup/index.html index db54267..224ae01 100755 --- a/getting-started_backup/index.html +++ b/getting-started_backup/index.html @@ -376,6 +376,8 @@ + + @@ -457,6 +459,27 @@ +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • diff --git a/index.html b/index.html index be83a35..094244f 100755 --- a/index.html +++ b/index.html @@ -438,6 +438,8 @@

    - A blessing and a curse

    + + @@ -519,6 +521,27 @@

    - A blessing and a curse

    +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • diff --git a/introduction/index.html b/introduction/index.html index 76e7d17..fa12fc4 100755 --- a/introduction/index.html +++ b/introduction/index.html @@ -382,6 +382,8 @@ + + @@ -547,6 +549,27 @@ +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • diff --git a/roadmap/index.html b/roadmap/index.html index c5ccaf3..fc34395 100755 --- a/roadmap/index.html +++ b/roadmap/index.html @@ -382,6 +382,8 @@ + + @@ -463,6 +465,27 @@ +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • diff --git a/schemas/jkum-schema-1.0/index.html b/schemas/jkum-schema-1.0/index.html index 9528c08..956ba30 100755 --- a/schemas/jkum-schema-1.0/index.html +++ b/schemas/jkum-schema-1.0/index.html @@ -380,6 +380,8 @@ + + @@ -461,6 +463,27 @@ +
  • + + + + + Examples + + + + +
    • + + + + + + + + + +
  • diff --git a/search/search_index.json b/search/search_index.json index c663f84..e9ab774 100755 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"file-structure/","title":"File structure","text":"

    All JKUM-compatible files should have the extension .jkum. The contents of the file is based on the JSON-file standard, and should in general follow all syntax regulations as described there.

    The file should consist of two primary attributes: the head and the manholes. The structure should be similar to this:

    {\n  \"head\": {\n    \"epsg\": 25832\n  }\n  \"manholes\": [...]\n}\n
    "},{"location":"file-structure/#minumum-file-sample","title":"Minumum file sample","text":"

    In order to generate a minimal and valid file, the JKUM-contents should be like this:

    {\n  \"head\": {\n    \"epsg\": 25832\n  }\n  \"manholes\": [\n    {\n      \"guid\": \n    }\n  ]\n}\n
    "},{"location":"getting-started/","title":"Getting started","text":"

    The project roadmap describes a goal of establishing open-source parsers for the JKUM-file format for lots of different programming languages. Currently, only a few are established.

    Language Supported? Status Repo C# Yes In progress JkumParser python No

    If you are familiar with any of the non-supported languages and want to contribute, feel free to drop an email to kontakt@vavisjon.no about it or submit a pull request, and we will add it here.

    "},{"location":"getting-started/#relevant-software","title":"Relevant software","text":"

    There will be apps and software solutions that will build upon this standard. This is a summarized list of softwares and solutions utilizing the JKUM-standard.

    Language Software Provider Type C# Autocad Civil JKUM Interface VA Visjon Open Source"},{"location":"getting-started_backup/","title":"Getting started","text":"

    The project roadmap describes a goal of establishing open-source parsers for the JKUM-file format for lots of different programming languages. Currently, only a few are established.

    Language Supported? Repo C# Yes JkumParser python No

    If you are familiar with any of the non-supported languages and want to contribute, feel free to drop an email to kontakt@vavisjon.no about it or submit a pull request, and we will add it here.

    "},{"location":"getting-started_backup/#relevant-software","title":"Relevant software","text":"

    There will be apps and software solutions that will build upon this standard. This is a summarized list of softwares and solutions utilizing the JKUM-standard.

    Language Software Provider Type C# Autocad Civil JKUM Interface VA Visjon Open Source"},{"location":"getting-started_backup/#installation","title":"Installation","text":""},{"location":"getting-started_backup/#with-pip","title":"with pip recommended","text":"

    Material for MkDocs is published as a Python package and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install Material for MkDocs with:

    Latest9.x 
    pip install mkdocs-material\n
    pip install mkdocs-material==\"9.*\" # (1)!\n

    1. Material for MkDocs uses semantic versioning1, which is why it's a good idea to limit upgrades to the current major version.

      This will make sure that you don't accidentally upgrade to the next major version, which may include breaking changes that silently corrupt your site. Additionally, you can use pip freeze to create a lockfile, so builds are reproducible at all times:

      pip freeze > requirements.txt\n

      Now, the lockfile can be used for installation:

      pip install -r requirements.txt\n

    This will automatically install compatible versions of all dependencies: [MkDocs], Markdown, Pygments and Python Markdown Extensions. Material for MkDocs always strives to support the latest versions, so there's no need to install those packages separately.

    How to set up Material for MkDocs by @james-willett \u2013 15m \u2013 Learn how to create and host a documentation site using Material for MkDocs on GitHub Pages in a step-by-step guide.

    Tip

    If you don't have prior experience with Python, we recommend reading Using Python's pip to Manage Your Projects' Dependencies, which is a really good introduction on the mechanics of Python package management and helps you troubleshoot if you run into errors.

    "},{"location":"getting-started_backup/#with-docker","title":"with docker","text":"

    The official Docker image is a great way to get up and running in a few minutes, as it comes with all dependencies pre-installed. Open up a terminal and pull the image with:

    Latest9.x 
    docker pull squidfunk/mkdocs-material\n
    docker pull squidfunk/mkdocs-material:9\n

    The mkdocs executable is provided as an entry point and serve is the default command. If you're not familiar with Docker don't worry, we have you covered in the following sections.

    The following plugins are bundled with the Docker image:

    • mkdocs-minify-plugin
    • mkdocs-redirects
    How to add plugins to the Docker image?

    Material for MkDocs only bundles selected plugins in order to keep the size of the official image small. If the plugin you want to use is not included, you can add them easily:

    Material for MkDocsInsiders

    Create a Dockerfile and extend the official image:

    Dockerfile
    FROM squidfunk/mkdocs-material\nRUN pip install mkdocs-macros-plugin\nRUN pip install mkdocs-glightbox\n

    Clone or fork the Insiders repository, and create a file called user-requirements.txt in the root of the repository. Then, add the plugins that should be installed to the file, e.g.:

    user-requirements.txt
    mkdocs-macros-plugin\nmkdocs-glightbox\n

    Next, build the image with the following command:

    docker build -t squidfunk/mkdocs-material .\n

    The new image will have additional packages installed and can be used exactly like the official image.

    "},{"location":"getting-started_backup/#with-git","title":"with git","text":"

    Material for MkDocs can be directly used from GitHub by cloning the repository into a subfolder of your project root which might be useful if you want to use the very latest version:

    git clone https://github.com/squidfunk/mkdocs-material.git\n

    Next, install the theme and its dependencies with:

    pip install -e mkdocs-material\n

    1. Note that improvements of existing features are sometimes released as patch releases, like for example improved rendering of content tabs, as they're not considered to be new features.\u00a0\u21a9

    "},{"location":"introduction/","title":"Getting started","text":"

    JKUM consist of a set of specifications for managing and transporting information that can be found when inspecting manholes. Since not all data is accessible at the time after pipes has been laid, the information in general file formats1 does not take into consideration that only one end of the intersecting pipes can be seen. Thus: the need for detailed specification of what can be seen inside a manhole when opening it.

    "},{"location":"introduction/#uses-of-this-file-format","title":"Uses of this file format","text":"

    The JKUM file format can be used for:

    • Registering data seen when opening manholes, and allowing easy transport of all data the surveyor finds, without any losses.
    • Interaction of concepts for pipe systems between applications and APIs.
    "},{"location":"introduction/#why-do-we-need-a-new-file-format","title":"Why do we need a new file format?","text":"

    Current practice of registrating the contents of the insides of manholes involves people going out into the field, and either:

    • Writing down the measurements and a sketch on a piece of paper.
    • Entering the registrations into an app or similar system.

    After that, the surveyor would go back into the office, and start managing the registrations, and producing whatever might be of value to the client that ordered the survey in the first place. Often, such end results would be a PDF per manhole, or in best cases: an Excel spreadsheet.

    However, the registration is not standardized anywhere, and thus there are as many ways to register this as there are surveyors. The need of a unified and supported mechanism for transporting this kind of data is dire!

    "},{"location":"introduction/#examples-of-current-status","title":"Examples of current status","text":"

    The current status can be represented here:

    This shows a sample of the current \"kumkort\" implementations as used by most surveyors in Norway. All surveyors apply their own implementation, and there are lots of variants to this."},{"location":"introduction/#existing-file-formats","title":"Existing file formats","text":"

    Currently, there are several file formats that may or may not be suited to transporting data about surveying and registering manhole data. However, we've found that none of them truly serves the purpose of the \"kumkort\" that's currently the de-facto \"standard\"2 of the field.

    Here, we try to summarize existing file formats and standards, and why they don't cover the needs covered by this standard.

    SOSIKOFIFC 
    Pros:\n\n- Well established file standard that's been around since the 1980's. \n- Rectified by the Norwegian mapping authorities.\n- Maintained and documented.\n\nCons:\n\n- Limited in how to represent what can be seen inside a manhole.\n- Dependant on knowing where the other end of the pipe is (which you don't know\n  when looking down into a manhole, unless you can also find the other end).\n- Complex implementation in GML with lots of objects and alternatives. \n  Not focused on manholes and its contents.\n- Pure Norwegian standard. Not used in other countries.\n
    Pros:\n\n- Very simple to implement\n- Easy to read and understand\n\nCons:\n\n- Relies on old SOSI codes, which has been deprecated for a long time.\n- Not manhole-oriented. Relies on the need to know where the other end of\n  the pipe is situated. Cannot represent a manhole by itself.\n- Can not represent a manhole as a single object. In order to cover all aspects\n  of a manhole, it needs to create lots of different objects that may or may not\n  be related\n
    Pros:\n\n- Well established file standard that's in use within the construction domain.\n- Integrates well into AEC-tools (Architechture, Engineering and Construction)\n\nCons:\n\n- Complex file standard with lots and lots of different supported objects.\n  It is also more building-oriented, and does not fully support details \n  for manhole objects.\n- File contents can have lot of freedom when it comes to properties and\n  property sets. There is a huge risk that different vendors will apply\n  different names for properties, thus making information transport difficult.\n

    Overall, we're led to the conclusion that no file format exists that can truly cover all we want to know about a single manhole, without relying on lots of other objects (the pipes) or doing geometric calculations to identify angles for inlets or outlets.

    1. There are several file formats, but none that covers all the requirements we've identified in our works with this standard.\u00a0\u21a9

    2. There are no standard. Every surveyor is expected to represent each manhole with some core data, like elevations, dimensions of pipes etc. How they go about it, is all up to them.\u00a0\u21a9

    "},{"location":"roadmap/","title":"Roadmap","text":"

    The current progress and roadmap of this project is:

    • Develop a basic standard version 1.0.
    • Develop documentation for the standard.
      • Initial configuration of the docs site.
      • Increase textual representation about the standard.
      • Implement a JSON schema reader to represent the standard in the docs.
    • Configure the standard in relation with users that need it.
    • Create readers and writers in different relevant languages.
      • Library for C#
      • Library for python
    "},{"location":"third-party-code/","title":"Third-part code","text":"

    The presentation of the JSON-schemas is rendered by the use of json-schema-for-humans. In order to identify which schema attributes is supported in these documentations, please see the page for supported JSON-attributes.

    "},{"location":"third-party-code/#licences","title":"Licences","text":""},{"location":"schemas/jkum-schema-1.0/","title":"JKUM 1.0","text":"

    Title: JKUM 1.0

    Type object Required No Additional properties [Not allowed]

    Description: A file standard for transporting information about manhole data

    Property Pattern Type Deprecated Definition Title/Description + head No object No In #/definitions/head - - manholes No array or null No - -"},{"location":"schemas/jkum-schema-1.0/#1-property-head","title":"1. Property head","text":"Type object Required Yes Additional properties [Not allowed] Defined in #/definitions/head

    Example: 

    {\n    \"epsg\": 28532,\n    \"date\": \"2024-01-17\",\n    \"author\": \"Hans Martin Eikerol\"\n}\n
    Property Pattern Type Deprecated Definition Title/Description + epsg No integer No - EPSG - date No string No - A valid date on the ISO 8601-format: YYYY-MM-DD - author No string No - The name of the company or author of the file"},{"location":"schemas/jkum-schema-1.0/#11-property-epsg","title":"1.1. Property epsg","text":"

    Title: EPSG

    Type integer Required Yes Default \"\"

    Description: A valid EPSG code, see www.epsg.io for reference.

    Examples: 

    25832\n
    25833\n
    5110\n
    5111\n
    Restrictions Must match regular expression ^[0-9]{4,5}$ Test"},{"location":"schemas/jkum-schema-1.0/#12-property-date","title":"1.2. Property date","text":"Type string Required No Default \"\"

    Description: A valid date on the ISO 8601-format: YYYY-MM-DD

    Example: 

    \"2020-01-22\"\n
    Restrictions Must match regular expression ^[0-9]{4}-(0[1-9]\\|1[0-2])-(0[1-9]\\|[1-2][0-9]\\|3[0-1])$ Test"},{"location":"schemas/jkum-schema-1.0/#13-property-author","title":"1.3. Property author","text":"Type string Required No Default \"\"

    Description: The name of the company or author of the file

    Example: 

    \"Hans Martin Eikerol\"\n
    "},{"location":"schemas/jkum-schema-1.0/#2-property-manholes","title":"2. Property manholes","text":"Type array or null Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description manhole -"},{"location":"schemas/jkum-schema-1.0/#21-manhole","title":"2.1. manhole","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/manhole Property Pattern Type Deprecated Definition Title/Description + guid No string No In #/definitions/guid - - elementId No string No - - + bottomCenter No object No In #/definitions/location - - shape No enum (of string) No - - - material No enum (of string) No - - - diameter No integer No - - - width No integer No - - - length No integer No - - - rotation No integer No - Clockwise cone or rectangular manhole rotation + lids No array No - - - links No array No - - - circumference No array No - -"},{"location":"schemas/jkum-schema-1.0/#211-property-guid","title":"2.1.1. Property guid","text":"Type string Required Yes Defined in #/definitions/guid

    Example: 

    \"cc984777-f7fc-475b-9f32-7cafd70a09cb\"\n
    Restrictions Must match regular expression ^[0-9a-fA-F]{8}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{12}$ Test"},{"location":"schemas/jkum-schema-1.0/#212-property-elementid","title":"2.1.2. Property elementId","text":"Type string Required No Default \"\"

    Example: 

    \"556001\"\n
    "},{"location":"schemas/jkum-schema-1.0/#213-property-bottomcenter","title":"2.1.3. Property bottomCenter","text":"Type object Required Yes Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#2131-property-east","title":"2.1.3.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2132-property-north","title":"2.1.3.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2133-property-elevation","title":"2.1.3.3. Property elevation","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#214-property-shape","title":"2.1.4. Property shape","text":"Type enum (of string) Required No Default \"Circular\"

    Example: 

    \"Rectangular\"\n

    Must be one of: * \"Circular\" * \"Rectangular\" * \"Polygon\"

    "},{"location":"schemas/jkum-schema-1.0/#215-property-material","title":"2.1.5. Property material","text":"Type enum (of string) Required No Default \"Concrete\"

    Example: 

    \"Concrete\"\n

    Must be one of: * \"Concrete\" * \"Bricks\" * \"Plastic\" * \"Rehabilitated\" * \"Other\"

    "},{"location":"schemas/jkum-schema-1.0/#216-property-diameter","title":"2.1.6. Property diameter","text":"Type integer Required No

    Example: 

    1600\n
    "},{"location":"schemas/jkum-schema-1.0/#217-property-width","title":"2.1.7. Property width","text":"Type integer Required No

    Example: 

    1200\n
    "},{"location":"schemas/jkum-schema-1.0/#218-property-length","title":"2.1.8. Property length","text":"Type integer Required No

    Example: 

    1600\n
    "},{"location":"schemas/jkum-schema-1.0/#219-property-rotation","title":"2.1.9. Property rotation","text":"

    Title: Clockwise cone or rectangular manhole rotation

    Type integer Required No Default 0

    Description: The rotation on a clock dial in degrees (0 - 360), starting at 12 O'clock, with positive numbers going clockwise

    Example: 

    120\n
    "},{"location":"schemas/jkum-schema-1.0/#2110-property-lids","title":"2.1.10. Property lids","text":"Type array Required Yes Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description lid -"},{"location":"schemas/jkum-schema-1.0/#21101-lid","title":"2.1.10.1. lid","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/lid Property Pattern Type Deprecated Definition Title/Description - guid No string or null No - - + position No object No In #/definitions/location - + diameter No integer No - - - ladder No enum (of string) No - - - classification No enum (of string) No - -"},{"location":"schemas/jkum-schema-1.0/#211011-property-guid","title":"2.1.10.1.1. Property guid","text":"Type string or null Required No"},{"location":"schemas/jkum-schema-1.0/#211012-property-position","title":"2.1.10.1.2. Property position","text":"Type object Required Yes Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#2110121-property-east","title":"2.1.10.1.2.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2110122-property-north","title":"2.1.10.1.2.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2110123-property-elevation","title":"2.1.10.1.2.3. Property elevation","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#211013-property-diameter","title":"2.1.10.1.3. Property diameter","text":"Type integer Required Yes

    Example: 

    650\n
    "},{"location":"schemas/jkum-schema-1.0/#211014-property-ladder","title":"2.1.10.1.4. Property ladder","text":"Type enum (of string) Required No Default \"Unspecified\"

    Example: 

    \"Yes\"\n

    Must be one of: * \"Unspecified\" * \"Yes\" * \"No\"

    "},{"location":"schemas/jkum-schema-1.0/#211015-property-classification","title":"2.1.10.1.5. Property classification","text":"Type enum (of string) Required No Default \"Unspecified\"

    Example: 

    \"D400\"\n

    Must be one of: * \"Unspecified\" * \"D400\" * \"D700\"

    "},{"location":"schemas/jkum-schema-1.0/#2111-property-links","title":"2.1.11. Property links","text":"Type array Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description manholeLink -"},{"location":"schemas/jkum-schema-1.0/#21111-manholelink","title":"2.1.11.1. manholeLink","text":"Type object or null Required No Defined in #/definitions/manholeLink Property Pattern Type Deprecated Definition Title/Description + guid No string No In #/definitions/guid - - elementId No string No - - - medium No string No - The medium transported in the pipe - direction No enum (of string) No - The assumed flow direction of the pipe contents + pressurized No boolean No - - + elevation No number No - - + clockPosition No integer No - The Clockposition Schema + diameter No integer No - -"},{"location":"schemas/jkum-schema-1.0/#211111-property-guid","title":"2.1.11.1.1. Property guid","text":"Type string Required Yes Defined in #/definitions/guid

    Example: 

    \"cc984777-f7fc-475b-9f32-7cafd70a09cb\"\n
    Restrictions Must match regular expression ^[0-9a-fA-F]{8}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{12}$ Test"},{"location":"schemas/jkum-schema-1.0/#211112-property-elementid","title":"2.1.11.1.2. Property elementId","text":"Type string Required No

    Example: 

    \"548861\"\n
    "},{"location":"schemas/jkum-schema-1.0/#211113-property-medium","title":"2.1.11.1.3. Property medium","text":"

    Title: The medium transported in the pipe

    Type string Required No

    Example: 

    \"Water\"\n
    "},{"location":"schemas/jkum-schema-1.0/#211114-property-direction","title":"2.1.11.1.4. Property direction","text":"

    Title: The assumed flow direction of the pipe contents

    Type enum (of string) Required No

    Example: 

    \"Ingoing\"\n

    Must be one of: * \"Ingoing\" * \"Outgoing\"

    "},{"location":"schemas/jkum-schema-1.0/#211115-property-pressurized","title":"2.1.11.1.5. Property pressurized","text":"Type boolean Required Yes Default false

    Example: 

    false\n
    "},{"location":"schemas/jkum-schema-1.0/#211116-property-elevation","title":"2.1.11.1.6. Property elevation","text":"Type number Required Yes

    Example: 

    53.11\n
    "},{"location":"schemas/jkum-schema-1.0/#211117-property-clockposition","title":"2.1.11.1.7. Property clockPosition","text":"

    Title: The Clockposition Schema

    Type integer Required Yes

    Example: 

    20\n
    Restrictions Must match regular expression ^[0-3][0-9]?[0-9]?$ Test"},{"location":"schemas/jkum-schema-1.0/#211118-property-diameter","title":"2.1.11.1.8. Property diameter","text":"Type integer Required Yes

    Example: 

    150\n
    "},{"location":"schemas/jkum-schema-1.0/#2112-property-circumference","title":"2.1.12. Property circumference","text":"Type array Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description manholeCircumference -"},{"location":"schemas/jkum-schema-1.0/#21121-manholecircumference","title":"2.1.12.1. manholeCircumference","text":"Type object or null Required No Defined in #/definitions/manholeCircumference Property Pattern Type Deprecated Definition Title/Description - innerVertices No array or null No - - - outerVertices No array or null No - -"},{"location":"schemas/jkum-schema-1.0/#211211-property-innervertices","title":"2.1.12.1.1. Property innerVertices","text":"Type array or null Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description location -"},{"location":"schemas/jkum-schema-1.0/#2112111-location","title":"2.1.12.1.1.1. location","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#21121111-property-east","title":"2.1.12.1.1.1.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121112-property-north","title":"2.1.12.1.1.1.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121113-property-elevation","title":"2.1.12.1.1.1.3. Property elevation","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#211212-property-outervertices","title":"2.1.12.1.2. Property outerVertices","text":"Type array or null Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description location -"},{"location":"schemas/jkum-schema-1.0/#2112121-location","title":"2.1.12.1.2.1. location","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#21121211-property-east","title":"2.1.12.1.2.1.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121212-property-north","title":"2.1.12.1.2.1.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121213-property-elevation","title":"2.1.12.1.2.1.3. Property elevation","text":"Type number Required Yes

    Generated using json-schema-for-humans on 2024-01-18 at 00:12:37 +0100

    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"examples/","title":"Examples","text":"

    This page comprise a few sample files that will be counted as valid files within the JKUM file format.

    "},{"location":"examples/#minumum-file-sample","title":"Minumum file sample","text":"

    In order to generate a minimal and valid file, the JKUM-contents should be like this:

    {\n  \"head\": {\n    \"epsg\": 25832,\n  },\n  \"manholes\": [\n    {\n      \"guid\": \"03de0a00-d6c0-4cb4-81bd-8f6ebdfad7a6\",\n      \"shape\": \"Circular\",\n      \"diameter\": 1600,\n      \"lids\": [\n        {\n          \"guid\": \"216e1618-bdf4-4ade-8Bg9-h9BBs34df115\",\n          \"position\": {\n            \"east\": 588447.155,\n            \"north\": 6642743.826,\n            \"elevation\": 55.145\n          }\n        }\n      ]\n    }\n  ]\n}\n
    "},{"location":"file-structure/","title":"File structure","text":"

    All JKUM-compatible files should have the extension .jkum. The contents of the file is based on the JSON-file standard, and should in general follow all syntax regulations as described there.

    The file should consist of two primary attributes: the head and the manholes. The structure should be similar to this:

    {\n  \"head\": {\n    \"epsg\": 25832\n  }\n  \"manholes\": [...]\n}\n
    "},{"location":"file-structure/#properties","title":"Properties","text":"

    The .jkum-file has two properties at the top level: head and manholes. In the following, all related objects and properties are described.

    "},{"location":"file-structure/#head","title":"Head","text":"

    The head property consists of these possible properties:

    Property Name Type Required Description epsg integer The EPSG ID for the coordinate system which the coordinates this file system is represented. date string An ISO 8601-formatted date string on the format YYYY-MM-DD. author string The name or descriptive text about the author of the file."},{"location":"file-structure/#manholes","title":"Manholes","text":"

    The manholes-property is an array consisting of Manhole.

    "},{"location":"file-structure/#manhole","title":"Manhole","text":"

    The properties for manholes are listed in this table.

    Property Name Type Required Description guid GUID A unique system-generated GUID for future reference and identification for the object. sid string A unique ID commonly used in mapping systems. Enables a better human-readable ID for the object. bottomCenter Location The position of the centerpoint of the manhole construction at its bottom center. shape string The shape of the Manhole, one of: Circular, Rectangular or Polygon. lids array<Lid> An array of Lid objects. Contains an array of Lids, since some manholes may have more than one Lid. pipes array<PipeConnection> An array of PipeConnection objects. imageData array<ImageData> An array of ImageData objects.

    Depending on the shape of the manhole, the following properties are also required:

    CircularRectangularPolygon Property Name Type Required Description diameter integer The manhole inner diameter in millimeters. Property Name Type Required Description width integer The manhole inner width in millimeters. length integer The manhole inner length in millimeters. Property Name Type Required Description circumference array A circumference-object consisting of the inner and outer boundary representing the Manhole constructions' shape."},{"location":"file-structure/#location","title":"Location","text":"

    The location-attribute consists of the three properties east, north and elevation.

    Property Name Type Required Description east float A float representing the east coordinate within the EPSG-system as defined in the file head-property. north float A float representing the north coordinate within the EPSG-system as defined in the file head-property. elevation float A float representing the elevation of the coordinate within the EPSG-system as defined in the file head-property."},{"location":"file-structure/#circumference","title":"Circumference","text":"Property Name Type Required Description innerVertices array<Location> An array of vertices within the EPSG-system as defined in the file head-property. outerVertices array<Location> An array of vertices within the EPSG-system as defined in the file head-property."},{"location":"file-structure/#lid","title":"Lid","text":"Property Name Type Required Description guid GUID A unique system-generated GUID for future reference and identification for the object. position Location The position of the center point of the lid in the terrain. diameter integer The manhole inner diameter in millimeters. ladder string If there is a ladder: Yes, otherwise No. Defaults to Unspecified in the absence of the property. classification string Details of the lid type, one of: Unspecified, D400, D700"},{"location":"file-structure/#pipeconnection","title":"PipeConnection","text":"

    When looking down into the manhole, pipe ends can be seen. Not knowing where the other end of the pipe is going or coming from, this file format instead focus on the relevant connector points that can be seen from inside the manhole.

    Property Name Type Required Description guid GUID A unique system-generated GUID for future reference and identification for the object. sid string A unique ID commonly used in mapping systems. Enables a better human-readable ID for the object. medium string The medium transported in the pipe. Must be one of the following: Water, Sewer, Storm water, Drain direction string The assumed flow direction of the pipe contents. Must be one of the following: Ingoing, Outgoing pressurized boolean If the pipe is a pressurized system. elevation float clockPosition integer diameter integer The pipe diameter in millimeters."},{"location":"file-structure/#imagedata","title":"ImageData","text":"

    The imageData-property should consist of at least one of the following data.

    Property Name Type Required Description base64String string A base 64 encoded string representing the image. imageUrl string A valid url to the location of the file, where it should be available for download."},{"location":"getting-started/","title":"Getting started","text":"

    The project roadmap describes a goal of establishing open-source parsers for the JKUM-file format for lots of different programming languages. Currently, only a few are established.

    Language Supported? Status Repo C# Yes Completed JkumParser python No

    If you are familiar with any of the non-supported languages and want to contribute, feel free to drop an email to kontakt@vavisjon.no about it or submit a pull request, and we will add it here.

    "},{"location":"getting-started/#relevant-software","title":"Relevant software","text":"

    There will be apps and software solutions that will build upon this standard. This is a summarized list of softwares and solutions utilizing the JKUM-standard.

    Language Software Provider Type C# Autocad Civil JKUM Interface VA Visjon Open Source"},{"location":"getting-started_backup/","title":"Getting started","text":"

    The project roadmap describes a goal of establishing open-source parsers for the JKUM-file format for lots of different programming languages. Currently, only a few are established.

    Language Supported? Repo C# Yes JkumParser python No

    If you are familiar with any of the non-supported languages and want to contribute, feel free to drop an email to kontakt@vavisjon.no about it or submit a pull request, and we will add it here.

    "},{"location":"getting-started_backup/#relevant-software","title":"Relevant software","text":"

    There will be apps and software solutions that will build upon this standard. This is a summarized list of softwares and solutions utilizing the JKUM-standard.

    Language Software Provider Type C# Autocad Civil JKUM Interface VA Visjon Open Source"},{"location":"getting-started_backup/#installation","title":"Installation","text":""},{"location":"getting-started_backup/#with-pip","title":"with pip recommended","text":"

    Material for MkDocs is published as a Python package and can be installed with pip, ideally by using a virtual environment. Open up a terminal and install Material for MkDocs with:

    Latest9.x 
    pip install mkdocs-material\n
    pip install mkdocs-material==\"9.*\" # (1)!\n

    1. Material for MkDocs uses semantic versioning1, which is why it's a good idea to limit upgrades to the current major version.

      This will make sure that you don't accidentally upgrade to the next major version, which may include breaking changes that silently corrupt your site. Additionally, you can use pip freeze to create a lockfile, so builds are reproducible at all times:

      pip freeze > requirements.txt\n

      Now, the lockfile can be used for installation:

      pip install -r requirements.txt\n

    This will automatically install compatible versions of all dependencies: [MkDocs], Markdown, Pygments and Python Markdown Extensions. Material for MkDocs always strives to support the latest versions, so there's no need to install those packages separately.

    How to set up Material for MkDocs by @james-willett \u2013 15m \u2013 Learn how to create and host a documentation site using Material for MkDocs on GitHub Pages in a step-by-step guide.

    Tip

    If you don't have prior experience with Python, we recommend reading Using Python's pip to Manage Your Projects' Dependencies, which is a really good introduction on the mechanics of Python package management and helps you troubleshoot if you run into errors.

    "},{"location":"getting-started_backup/#with-docker","title":"with docker","text":"

    The official Docker image is a great way to get up and running in a few minutes, as it comes with all dependencies pre-installed. Open up a terminal and pull the image with:

    Latest9.x 
    docker pull squidfunk/mkdocs-material\n
    docker pull squidfunk/mkdocs-material:9\n

    The mkdocs executable is provided as an entry point and serve is the default command. If you're not familiar with Docker don't worry, we have you covered in the following sections.

    The following plugins are bundled with the Docker image:

    • mkdocs-minify-plugin
    • mkdocs-redirects
    How to add plugins to the Docker image?

    Material for MkDocs only bundles selected plugins in order to keep the size of the official image small. If the plugin you want to use is not included, you can add them easily:

    Material for MkDocsInsiders

    Create a Dockerfile and extend the official image:

    Dockerfile
    FROM squidfunk/mkdocs-material\nRUN pip install mkdocs-macros-plugin\nRUN pip install mkdocs-glightbox\n

    Clone or fork the Insiders repository, and create a file called user-requirements.txt in the root of the repository. Then, add the plugins that should be installed to the file, e.g.:

    user-requirements.txt
    mkdocs-macros-plugin\nmkdocs-glightbox\n

    Next, build the image with the following command:

    docker build -t squidfunk/mkdocs-material .\n

    The new image will have additional packages installed and can be used exactly like the official image.

    "},{"location":"getting-started_backup/#with-git","title":"with git","text":"

    Material for MkDocs can be directly used from GitHub by cloning the repository into a subfolder of your project root which might be useful if you want to use the very latest version:

    git clone https://github.com/squidfunk/mkdocs-material.git\n

    Next, install the theme and its dependencies with:

    pip install -e mkdocs-material\n

    1. Note that improvements of existing features are sometimes released as patch releases, like for example improved rendering of content tabs, as they're not considered to be new features.\u00a0\u21a9

    "},{"location":"introduction/","title":"Getting started","text":"

    JKUM consist of a set of specifications for managing and transporting information that can be found when inspecting manholes. Since not all data is accessible at the time after pipes has been laid, the information in general file formats1 does not take into consideration that only one end of the intersecting pipes can be seen. Thus: the need for detailed specification of what can be seen inside a manhole when opening it.

    "},{"location":"introduction/#uses-of-this-file-format","title":"Uses of this file format","text":"

    The JKUM file format can be used for:

    • Registering data seen when opening manholes, and allowing easy transport of all data the surveyor finds, without any losses.
    • Interaction of concepts for pipe systems between applications and APIs.
    "},{"location":"introduction/#why-do-we-need-a-new-file-format","title":"Why do we need a new file format?","text":"

    Current practice of registrating the contents of the insides of manholes involves people going out into the field, and either:

    • Writing down the measurements and a sketch on a piece of paper.
    • Entering the registrations into an app or similar system.

    After that, the surveyor would go back into the office, and start managing the registrations, and producing whatever might be of value to the client that ordered the survey in the first place. Often, such end results would be a PDF per manhole, or in best cases: an Excel spreadsheet.

    However, the registration is not standardized anywhere, and thus there are as many ways to register this as there are surveyors. The need of a unified and supported mechanism for transporting this kind of data is dire!

    "},{"location":"introduction/#examples-of-current-status","title":"Examples of current status","text":"

    The current status can be represented here:

    This shows a sample of the current \"kumkort\" implementations as used by most surveyors in Norway. All surveyors apply their own implementation, and there are lots of variants to this."},{"location":"introduction/#existing-file-formats","title":"Existing file formats","text":"

    Currently, there are several file formats that may or may not be suited to transporting data about surveying and registering manhole data. However, we've found that none of them truly serves the purpose of the \"kumkort\" that's currently the de-facto \"standard\"2 of the field.

    Here, we try to summarize existing file formats and standards, and why they don't cover the needs covered by this standard.

    SOSIKOFIFC 
    Pros:\n\n- Well established file standard that's been around since the 1980's. \n- Rectified by the Norwegian mapping authorities.\n- Maintained and documented.\n\nCons:\n\n- Limited in how to represent what can be seen inside a manhole.\n- Dependant on knowing where the other end of the pipe is (which you don't know\n  when looking down into a manhole, unless you can also find the other end).\n- Complex implementation in GML with lots of objects and alternatives. \n  Not focused on manholes and its contents.\n- Pure Norwegian standard. Not used in other countries.\n
    Pros:\n\n- Very simple to implement\n- Easy to read and understand\n\nCons:\n\n- Relies on old SOSI codes, which has been deprecated for a long time.\n- Not manhole-oriented. Relies on the need to know where the other end of\n  the pipe is situated. Cannot represent a manhole by itself.\n- Can not represent a manhole as a single object. In order to cover all aspects\n  of a manhole, it needs to create lots of different objects that may or may not\n  be related\n
    Pros:\n\n- Well established file standard that's in use within the construction domain.\n- Integrates well into AEC-tools (Architechture, Engineering and Construction)\n\nCons:\n\n- Complex file standard with lots and lots of different supported objects.\n  It is also more building-oriented, and does not fully support details \n  for manhole objects.\n- File contents can have lot of freedom when it comes to properties and\n  property sets. There is a huge risk that different vendors will apply\n  different names for properties, thus making information transport difficult.\n

    Overall, we're led to the conclusion that no file format exists that can truly cover all we want to know about a single manhole, without relying on lots of other objects (the pipes) or doing geometric calculations to identify angles for inlets or outlets.

    1. There are several file formats, but none that covers all the requirements we've identified in our works with this standard.\u00a0\u21a9

    2. There are no standard. Every surveyor is expected to represent each manhole with some core data, like elevations, dimensions of pipes etc. How they go about it, is all up to them.\u00a0\u21a9

    "},{"location":"roadmap/","title":"Roadmap","text":"

    The current progress and roadmap of this project is:

    • Develop a basic standard version 1.0.
    • Develop documentation for the standard.
      • Initial configuration of the docs site.
      • Increase textual representation about the standard.
      • Implement a JSON schema reader to represent the standard in the docs.
    • Configure the standard in relation with users that need it.
    • Create readers and writers in different relevant languages.
      • Library for C#
      • Library for python
    "},{"location":"third-party-code/","title":"Third-party code","text":"

    The presentation of the JSON-schemas is rendered by the use of json-schema-for-humans. In order to identify which schema attributes is supported in these documentations, please see the page for supported JSON-attributes.

    "},{"location":"third-party-code/#licences","title":"Licences","text":""},{"location":"schemas/jkum-schema-1.0/","title":"JKUM 1.0","text":"

    Title: JKUM 1.0

    Type object Required No Additional properties [Not allowed]

    Description: A file standard for transporting information about manhole data

    Property Pattern Type Deprecated Definition Title/Description + head No object No In #/definitions/head - - manholes No array or null No - -"},{"location":"schemas/jkum-schema-1.0/#1-property-head","title":"1. Property head","text":"Type object Required Yes Additional properties [Not allowed] Defined in #/definitions/head

    Example: 

    {\n    \"epsg\": 28532,\n    \"date\": \"2024-01-17\",\n    \"author\": \"Hans Martin Eikerol\"\n}\n
    Property Pattern Type Deprecated Definition Title/Description + epsg No integer No - EPSG - date No string No - A valid date on the ISO 8601-format: YYYY-MM-DD - author No string No - The name of the company or author of the file"},{"location":"schemas/jkum-schema-1.0/#11-property-epsg","title":"1.1. Property epsg","text":"

    Title: EPSG

    Type integer Required Yes Default \"\"

    Description: A valid EPSG code, see www.epsg.io for reference.

    Examples: 

    25832\n
    25833\n
    5110\n
    5111\n
    Restrictions Must match regular expression ^[0-9]{4,5}$ Test"},{"location":"schemas/jkum-schema-1.0/#12-property-date","title":"1.2. Property date","text":"Type string Required No Default \"\"

    Description: A valid date on the ISO 8601-format: YYYY-MM-DD

    Example: 

    \"2020-01-22\"\n
    Restrictions Must match regular expression ^[0-9]{4}-(0[1-9]\\|1[0-2])-(0[1-9]\\|[1-2][0-9]\\|3[0-1])$ Test"},{"location":"schemas/jkum-schema-1.0/#13-property-author","title":"1.3. Property author","text":"Type string Required No Default \"\"

    Description: The name of the company or author of the file

    Example: 

    \"Hans Martin Eikerol\"\n
    "},{"location":"schemas/jkum-schema-1.0/#2-property-manholes","title":"2. Property manholes","text":"Type array or null Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description manhole -"},{"location":"schemas/jkum-schema-1.0/#21-manhole","title":"2.1. manhole","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/manhole Property Pattern Type Deprecated Definition Title/Description + guid No string No In #/definitions/guid - - elementId No string No - - + bottomCenter No object No In #/definitions/location - - shape No enum (of string) No - - - material No enum (of string) No - - - diameter No integer No - - - width No integer No - - - length No integer No - - - rotation No integer No - Clockwise cone or rectangular manhole rotation + lids No array No - - - links No array No - - - circumference No array No - -"},{"location":"schemas/jkum-schema-1.0/#211-property-guid","title":"2.1.1. Property guid","text":"Type string Required Yes Defined in #/definitions/guid

    Example: 

    \"cc984777-f7fc-475b-9f32-7cafd70a09cb\"\n
    Restrictions Must match regular expression ^[0-9a-fA-F]{8}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{12}$ Test"},{"location":"schemas/jkum-schema-1.0/#212-property-elementid","title":"2.1.2. Property elementId","text":"Type string Required No Default \"\"

    Example: 

    \"556001\"\n
    "},{"location":"schemas/jkum-schema-1.0/#213-property-bottomcenter","title":"2.1.3. Property bottomCenter","text":"Type object Required Yes Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#2131-property-east","title":"2.1.3.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2132-property-north","title":"2.1.3.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2133-property-elevation","title":"2.1.3.3. Property elevation","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#214-property-shape","title":"2.1.4. Property shape","text":"Type enum (of string) Required No Default \"Circular\"

    Example: 

    \"Rectangular\"\n

    Must be one of: * \"Circular\" * \"Rectangular\" * \"Polygon\"

    "},{"location":"schemas/jkum-schema-1.0/#215-property-material","title":"2.1.5. Property material","text":"Type enum (of string) Required No Default \"Concrete\"

    Example: 

    \"Concrete\"\n

    Must be one of: * \"Concrete\" * \"Bricks\" * \"Plastic\" * \"Rehabilitated\" * \"Other\"

    "},{"location":"schemas/jkum-schema-1.0/#216-property-diameter","title":"2.1.6. Property diameter","text":"Type integer Required No

    Example: 

    1600\n
    "},{"location":"schemas/jkum-schema-1.0/#217-property-width","title":"2.1.7. Property width","text":"Type integer Required No

    Example: 

    1200\n
    "},{"location":"schemas/jkum-schema-1.0/#218-property-length","title":"2.1.8. Property length","text":"Type integer Required No

    Example: 

    1600\n
    "},{"location":"schemas/jkum-schema-1.0/#219-property-rotation","title":"2.1.9. Property rotation","text":"

    Title: Clockwise cone or rectangular manhole rotation

    Type integer Required No Default 0

    Description: The rotation on a clock dial in degrees (0 - 360), starting at 12 O'clock, with positive numbers going clockwise

    Example: 

    120\n
    "},{"location":"schemas/jkum-schema-1.0/#2110-property-lids","title":"2.1.10. Property lids","text":"Type array Required Yes Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description lid -"},{"location":"schemas/jkum-schema-1.0/#21101-lid","title":"2.1.10.1. lid","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/lid Property Pattern Type Deprecated Definition Title/Description - guid No string or null No - - + position No object No In #/definitions/location - + diameter No integer No - - - ladder No enum (of string) No - - - classification No enum (of string) No - -"},{"location":"schemas/jkum-schema-1.0/#211011-property-guid","title":"2.1.10.1.1. Property guid","text":"Type string or null Required No"},{"location":"schemas/jkum-schema-1.0/#211012-property-position","title":"2.1.10.1.2. Property position","text":"Type object Required Yes Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#2110121-property-east","title":"2.1.10.1.2.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2110122-property-north","title":"2.1.10.1.2.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#2110123-property-elevation","title":"2.1.10.1.2.3. Property elevation","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#211013-property-diameter","title":"2.1.10.1.3. Property diameter","text":"Type integer Required Yes

    Example: 

    650\n
    "},{"location":"schemas/jkum-schema-1.0/#211014-property-ladder","title":"2.1.10.1.4. Property ladder","text":"Type enum (of string) Required No Default \"Unspecified\"

    Example: 

    \"Yes\"\n

    Must be one of: * \"Unspecified\" * \"Yes\" * \"No\"

    "},{"location":"schemas/jkum-schema-1.0/#211015-property-classification","title":"2.1.10.1.5. Property classification","text":"Type enum (of string) Required No Default \"Unspecified\"

    Example: 

    \"D400\"\n

    Must be one of: * \"Unspecified\" * \"D400\" * \"D700\"

    "},{"location":"schemas/jkum-schema-1.0/#2111-property-links","title":"2.1.11. Property links","text":"Type array Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description manholeLink -"},{"location":"schemas/jkum-schema-1.0/#21111-manholelink","title":"2.1.11.1. manholeLink","text":"Type object or null Required No Defined in #/definitions/manholeLink Property Pattern Type Deprecated Definition Title/Description + guid No string No In #/definitions/guid - - elementId No string No - - - medium No string No - The medium transported in the pipe - direction No enum (of string) No - The assumed flow direction of the pipe contents + pressurized No boolean No - - + elevation No number No - - + clockPosition No integer No - The Clockposition Schema + diameter No integer No - -"},{"location":"schemas/jkum-schema-1.0/#211111-property-guid","title":"2.1.11.1.1. Property guid","text":"Type string Required Yes Defined in #/definitions/guid

    Example: 

    \"cc984777-f7fc-475b-9f32-7cafd70a09cb\"\n
    Restrictions Must match regular expression ^[0-9a-fA-F]{8}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{4}[-]{1}[0-9a-fA-F]{12}$ Test"},{"location":"schemas/jkum-schema-1.0/#211112-property-elementid","title":"2.1.11.1.2. Property elementId","text":"Type string Required No

    Example: 

    \"548861\"\n
    "},{"location":"schemas/jkum-schema-1.0/#211113-property-medium","title":"2.1.11.1.3. Property medium","text":"

    Title: The medium transported in the pipe

    Type string Required No

    Example: 

    \"Water\"\n
    "},{"location":"schemas/jkum-schema-1.0/#211114-property-direction","title":"2.1.11.1.4. Property direction","text":"

    Title: The assumed flow direction of the pipe contents

    Type enum (of string) Required No

    Example: 

    \"Ingoing\"\n

    Must be one of: * \"Ingoing\" * \"Outgoing\"

    "},{"location":"schemas/jkum-schema-1.0/#211115-property-pressurized","title":"2.1.11.1.5. Property pressurized","text":"Type boolean Required Yes Default false

    Example: 

    false\n
    "},{"location":"schemas/jkum-schema-1.0/#211116-property-elevation","title":"2.1.11.1.6. Property elevation","text":"Type number Required Yes

    Example: 

    53.11\n
    "},{"location":"schemas/jkum-schema-1.0/#211117-property-clockposition","title":"2.1.11.1.7. Property clockPosition","text":"

    Title: The Clockposition Schema

    Type integer Required Yes

    Example: 

    20\n
    Restrictions Must match regular expression ^[0-3][0-9]?[0-9]?$ Test"},{"location":"schemas/jkum-schema-1.0/#211118-property-diameter","title":"2.1.11.1.8. Property diameter","text":"Type integer Required Yes

    Example: 

    150\n
    "},{"location":"schemas/jkum-schema-1.0/#2112-property-circumference","title":"2.1.12. Property circumference","text":"Type array Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description manholeCircumference -"},{"location":"schemas/jkum-schema-1.0/#21121-manholecircumference","title":"2.1.12.1. manholeCircumference","text":"Type object or null Required No Defined in #/definitions/manholeCircumference Property Pattern Type Deprecated Definition Title/Description - innerVertices No array or null No - - - outerVertices No array or null No - -"},{"location":"schemas/jkum-schema-1.0/#211211-property-innervertices","title":"2.1.12.1.1. Property innerVertices","text":"Type array or null Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description location -"},{"location":"schemas/jkum-schema-1.0/#2112111-location","title":"2.1.12.1.1.1. location","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#21121111-property-east","title":"2.1.12.1.1.1.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121112-property-north","title":"2.1.12.1.1.1.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121113-property-elevation","title":"2.1.12.1.1.1.3. Property elevation","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#211212-property-outervertices","title":"2.1.12.1.2. Property outerVertices","text":"Type array or null Required No Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below Each item of this array must be Description location -"},{"location":"schemas/jkum-schema-1.0/#2112121-location","title":"2.1.12.1.2.1. location","text":"Type object Required No Additional properties [Any type: allowed] Defined in #/definitions/location Property Pattern Type Deprecated Definition Title/Description + east No number No - - + north No number No - - + elevation No number No - -"},{"location":"schemas/jkum-schema-1.0/#21121211-property-east","title":"2.1.12.1.2.1.1. Property east","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121212-property-north","title":"2.1.12.1.2.1.2. Property north","text":"Type number Required Yes"},{"location":"schemas/jkum-schema-1.0/#21121213-property-elevation","title":"2.1.12.1.2.1.3. Property elevation","text":"Type number Required Yes

    Generated using json-schema-for-humans on 2024-01-18 at 00:12:37 +0100

    "}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index a0f9273..24c8fdc 100755 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,42 +2,47 @@ https://hansmei.github.io/jkum-site/ - 2024-01-18 + 2024-01-20 + daily + + + https://hansmei.github.io/jkum-site/examples/ + 2024-01-20 daily https://hansmei.github.io/jkum-site/file-structure/ - 2024-01-18 + 2024-01-20 daily https://hansmei.github.io/jkum-site/getting-started/ - 2024-01-18 + 2024-01-20 daily https://hansmei.github.io/jkum-site/getting-started_backup/ - 2024-01-18 + 2024-01-20 daily https://hansmei.github.io/jkum-site/introduction/ - 2024-01-18 + 2024-01-20 daily https://hansmei.github.io/jkum-site/roadmap/ - 2024-01-18 + 2024-01-20 daily https://hansmei.github.io/jkum-site/third-party-code/ - 2024-01-18 + 2024-01-20 daily https://hansmei.github.io/jkum-site/schemas/jkum-schema-1.0/ - 2024-01-18 + 2024-01-20 daily \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 532c1a6dc8de17d5997d9420b320ae3e4dc0ccaf..489108c4a786ae97a64b0e9e97e05d13a6202855 100755 GIT binary patch literal 304 zcmV-00nh#)iwFo%L9As0|8r?{Wo=<_E_iKh0M(VvZo?o9$M1cLD0d)@cG#vQz4ZyU z^F)CrtbAl(miF!EB;Azrq)E&dux0-G32f6GuGSQvDn#vFTkdI97Rm`Pwd>pR_2oz& z%R{$oQZP|LfypkmY{G%521{LB3MBxBdd&)yXuCMFwvLn>C1!gv+5^=(65o=@~Z zj$&8m=#qf~i+yTH2QWNwK8_SE=BQmzVsc4n z(@CFtV_9pV%V%Z-f4k - + @@ -82,7 +82,7 @@
    - + Skip to content @@ -382,6 +382,8 @@ + + @@ -463,6 +465,27 @@ + + +
  • + + + + + Examples + + + + +
    • + + + + + + + + @@ -475,6 +498,17 @@ + + @@ -485,6 +519,34 @@ + + + +

    • @@ -684,6 +746,23 @@ + + +
    @@ -713,11 +792,11 @@ -

    Third-part code

    +

    Third-party code

    The presentation of the JSON-schemas is rendered by the use of json-schema-for-humans. In order to identify which schema attributes is supported in these documentations, please see the page for supported JSON-attributes.

    -

    Licences

    +

    Licences

    @@ -753,7 +832,7 @@

    Licences - +
    @@ -763,7 +842,7 @@

    Licences - File structure + Examples