From fefd685943b2dac575e3b0b36e477f48acbba6da Mon Sep 17 00:00:00 2001 From: "Deployment Bot (from Travis CI)" Date: Fri, 2 Feb 2024 12:12:29 +0000 Subject: [PATCH] Deploy kalisio/kano to github.com/kalisio/kano.git:gh-pages --- 404.html | 2 +- about/contact.html | 2 +- about/contributing.html | 2 +- about/introduction.html | 2 +- about/license.html | 2 +- about/roadmap.html | 2 +- guides/advanced-usage.html | 2 +- guides/customizing-kano.html | 2 +- guides/getting-started.html | 2 +- guides/installing-kano.html | 2 +- guides/installing-services.html | 2 +- guides/kano-api.html | 2 +- guides/understanding-kano.html | 2 +- hashmap.json | 2 +- index.html | 2 +- reference/api.html | 2 +- reference/configuration.html | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/404.html b/404.html index 8cb7e9d3..6ff9b5d0 100644 --- a/404.html +++ b/404.html @@ -17,7 +17,7 @@
Kano

Appearance

404

PAGE NOT FOUND

But if you don't change your direction, and if you keep looking, you may end up where you are heading.
Take me home

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/about/contact.html b/about/contact.html index fe04e89f..e596acb3 100644 --- a/about/contact.html +++ b/about/contact.html @@ -20,7 +20,7 @@
Kano

Appearance

Contact ​

Please feel free to join our slack channel using the invitation link.

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/about/contributing.html b/about/contributing.html index 3f53739c..2742896f 100644 --- a/about/contributing.html +++ b/about/contributing.html @@ -20,7 +20,7 @@
Kano

Appearance

Contributing ​

Submission guidelines ​

Report a bug ​

Before creating an issue please make sure you have checked out the docs, you might want to also try searching Github. It's pretty likely someone has already asked a similar question.

Issues can be reported in the issue tracker.

Pull Requests ​

We love pull requests and we're continually working to make it as easy as possible for people to contribute.

We prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A core team member will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.

Although we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context or information regarding the roadmap that the core team members have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it.

Commit message guidelines ​

We follow the Conventional commits specifications which provides a set of rules to make commit messages more readable when looking through the project history. But also, we use the git commit messages to generate the change log.

Commit message format ​

The commit message should be structured as follows:

<type>: <subject> [optional `breaking`]

Where type must be one of the following:

  • build: changes that affect the build system (external dependencies)
  • ci: changes to our CI configuration files and scripts
  • chore: changes that affect the project structure
  • docs: changes that affect the documentation only
  • feat: a new feature
  • fix: a bug fix
  • perf: a code change that improves performance
  • refactor: a code change that neither fixes a bug nor adds a feature
  • revert: revert changes
  • style: changes that do not affect the meaning of the code (lint issues)
  • test: adding missing tests or correcting existing tests

Use the optional [ breaking ] keyword to declare a BREAKING CHANGE.

Examples ​

  • Commit message with description and breaking change in body
feat: allow provided config object to extend other configs [ breaking ]
  • Commit message with no body
docs: correct spelling in the contributing.md file
  • Commit message for a fix using an issue number.
fix: fix minor issue in code (#12)

Versioning guidelines ​

We rely on Semantic Versioning for versioning a release. Indeed, given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make a major evolution leading to breaking changes,
  • MINOR version when you add functionality in a backwards-compatible manner
  • PATCH version when you make backwards-compatible bug fixes.

The command npm run release:<type>, where <type> is either patch, minor or major, helps you to do the release.

It performs the following task for you:

  • increase the package version number in the package.json file
  • generate the change log
  • create a tag accordingly in the git repository and push it

Contributor Code of Conduct ​

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant, version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/about/introduction.html b/about/introduction.html index 2d8aa6b0..4be3e195 100644 --- a/about/introduction.html +++ b/about/introduction.html @@ -20,7 +20,7 @@
Kano

Appearance

Introduction ​

Kano is a powerful application that can be used to visualize any time-varying geospatial data, notably served by Kargo.

kano-screenshot

TIP

This application is based on the Kalisio Development Kit.

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/about/license.html b/about/license.html index 7de604bd..5865107a 100644 --- a/about/license.html +++ b/about/license.html @@ -20,7 +20,7 @@
Kano

Appearance

License ​

MIT License

Copyright (c) 2017-202x Kalisio

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/about/roadmap.html b/about/roadmap.html index b89c0025..b6d46ff8 100644 --- a/about/roadmap.html +++ b/about/roadmap.html @@ -20,7 +20,7 @@
Kano

Appearance

Roadmap ​

The roadmap is available on Github.

Milestones ​

The milestones are available on Github

Release Notes ​

The changelog is available in Github

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/guides/advanced-usage.html b/guides/advanced-usage.html index 8760a73e..920d8dd9 100644 --- a/guides/advanced-usage.html +++ b/guides/advanced-usage.html @@ -123,7 +123,7 @@ ... } } - + \ No newline at end of file diff --git a/guides/customizing-kano.html b/guides/customizing-kano.html index b1cbc949..8cf2d764 100644 --- a/guides/customizing-kano.html +++ b/guides/customizing-kano.html @@ -515,7 +515,7 @@ -d @stations-data.json https://your.kano.domain/api/sensors-stations curl -X POST -H "Authorization: Bearer %TOKEN%" -H "Content-Type: application/json" ^ -d @observations-data.json https://your.kano.domain/api/sensors-observations

TIP

For testing purpose you can get a valid token from the local storage in the developer tool after logged into Kano.

Using the bottom timeline, navigate to a date/time with existing sensor data, you now should be able to see your sensor on the map, selecting it should open the value timeseries:

sensors layers

A data layer can contain multiple time-varying elements called variables. The features may contain additional properties, e.g. a status (OK/NOK), a name, etc. that can be used to customize the rendering, e.g. icon, color, tooltip, etc.

The main configuration options are the following:

TIP

A layer can have no fixed stations but only measurements from sensors in order to display moving data

Customizing the catalog legend ​

To be completed

- + \ No newline at end of file diff --git a/guides/getting-started.html b/guides/getting-started.html index 78617849..36a844f3 100644 --- a/guides/getting-started.html +++ b/guides/getting-started.html @@ -20,7 +20,7 @@
Kano

Appearance

Getting Started ​

Kano comes with small tutorials (a.k.a. tours) that can be directly run on the application in order to understand how its internal components can be used. You will first have to connect to make everything works as expected.

Then, you can launch the main tutorial directly from the main menu through the following icon . Follow the step by step guide , go back if required and stop anytime as illustrated by the following figure:

tour

From the main tutorial you can open others tutorials dedicated to specific components (like e.g. the navigation bar) whenever you see the icon.

WARNING

Kano look and features are ever-evolving, moreover it can be configured according to your specific use case. As a consequence, your screen probably looks a little different than what you can read and see in this documentation but the key concepts remain the same.

The main menu allows to open the documentation, manage your settings and logout from Kano.

👉 Launch the main tutorial from the main menu then open the link to the main menu tutorial to get more details

Application bar ​

The application bar allows to quickly execute recurring actions:

  • switch from 2D (respectively 3D) activity to 3D (respectively 2D) activity,
  • center the view on your current location and display it,
  • seek for an address,
  • manage your favorite views,
  • tools to e.g. display the coordinates of a location,
  • switch to fullscreen mode.

👉 Launch the main tutorial from the main menu then open the link to the navigation bar tutorial to get more details

Catalog ​

The catalog allows to manage the layers displayed on your view. You can show/hide a layer by selecting it in the relevant category.

WARNING

The data of some layers are only visible starting from a given scale if there is too much data to ensure a readable and smvisualisation.

In this case the layer will be disable until you reach the required scale on the map (zoom in or zoom to the layer to do so).

Using the menu on a layer you can access available actions for this layer.

👉 Launch the main tutorial from the main menu then open the link to the catalog tutorial to get more details

Timeline ​

The timeline allows to quickly execute actions related to the time of the displayed data. Stick to real-time or go forward/backward in time as you wish.

👉 Launch the main tutorial from the main menu then open the link to the timeline tutorial to get more details

Floating action button ​

Using the FAB at the bottom right corner you can:

  • Create a new blank data layer:
    • By connecting to web mapping services using OGC standards (WMS, WFS, TMS, WMTS).
    • By locating and drawing the underlying entities. You can add the data schema from a JSON schema file in order to edit the meatadata (i.e. properties) of your entities.
    • By import existing data from a GeoJSON file.
  • Probe weather forecast data from active prediction models by selecting a specific location on the map.

👉 Launch the main tutorial from the main menu then open the link to the FAB tutorial to get more details

Contextual menu ​

A right-click on a feature of the map will display a contextual menu if some actions are available for the target element like editing the properties of a user-defined feature or remove it.

Layer actions ​

Depending on the layer different actions are available. The most common action is to zoom to the layer in order to fit the view on the available data. If the layer is disabled at high scales this action will set the current scale of the map so that data will start be visible if the layer is shown.

More actions are available on user-defined feature layers:

  • save the layer (i.e. make it persistent),
  • edit layer properties like its name or description,
  • edit layer features (metadata and geometry),
  • edit display style,
  • filter data according to metadata,
  • display raw data,
  • create charts,
  • delete the layer.

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/guides/installing-kano.html b/guides/installing-kano.html index 9679f05e..682a4954 100644 --- a/guides/installing-kano.html +++ b/guides/installing-kano.html @@ -255,7 +255,7 @@ // Now you can launch the jobs manually using the krawler CLI krawler ./jobfile-hydro-stations.js krawler ./jobfile-hydro-observations.js - + \ No newline at end of file diff --git a/guides/installing-services.html b/guides/installing-services.html index d60c2dd7..2ed7a9a6 100644 --- a/guides/installing-services.html +++ b/guides/installing-services.html @@ -113,7 +113,7 @@ export PORT="8084" export NODE_OPTIONS="--inspect-port=9234" yarn dev

Add k2 ​

Coming soon

- + \ No newline at end of file diff --git a/guides/kano-api.html b/guides/kano-api.html index 8df410ad..981cd038 100644 --- a/guides/kano-api.html +++ b/guides/kano-api.html @@ -138,7 +138,7 @@ } ] }

Use case example ​

We used the Kano API to expose French nuclear power production data to a set of Grafana dashboards.

We first developed a Krawler job whose task is to scrap power production data and to push it into Kano's backing MongoDB database. On Kano's side, we added a layer declaring a feature service pointing on the database collections the Krawler job was populating. From that time, nuclear power production data was available for display in Kano. Here's what it looks like :

Nucler power production data in Kano

Once the collections started being populated, we looked for ways to connect Grafana to Kano's API endpoint. For this we used the Infinity Grafana datasource plugin allowing us to use it's JSON scrapping capabilities to feed Grafana. We created a JWT token for the datasource to be able to reach Kano's API. After creating dashboards and looking up some docs, we ended up with a set of synthetic dashboards:

Nuclear power production overview in GrafanaNuclear power production detail in Grafana

Overall, here's the architecture of the whole solution :

Whole use case architecture

- + \ No newline at end of file diff --git a/guides/understanding-kano.html b/guides/understanding-kano.html index a2141b77..5b086f62 100644 --- a/guides/understanding-kano.html +++ b/guides/understanding-kano.html @@ -20,7 +20,7 @@
Kano

Appearance

Understanding Kano ​

Kano is a powerful geospatial visualizer supporting advanced visualization capabilities in 2D and 3D thanks to hardware acceleration with WebGL technology. Driven by today's most advanced web technologies, it also enables tracking your geospatial assets in real-time.

Although Kano is a web application for end-users, it has also been designed to be integrated in third-party business applications and customized by developers (check out advanced usage). Using a single and simple API, Kano provides developers with the capability to easily develop 2D and 3D geospatial applications (check out the API reference). Last but not least, Kano comes with a built-in configuration for a set of geospatial data (check out installation guide). However, you can complete it with your own spatial data.

Key concepts ​

Here is a quick rundown of the key concepts to handle when you're just getting started with Kano or geographic information system (GIS). In a nutshell, like any other GIS tool, Kano can be used to map, analyze, and assess real-world problems based on data, which is spatial or geographical in nature.

To achieve this, Kano is composed of two main activities (i.e. entry point for interacting with the user on a given type of objects):

  • a 2D activity to visualise and interact with data on a standard paperless map in 2D,
  • a 3D activity to visualise data and interact with on a virtual globe in 3D.

The view of each activity can contain a basemap (i.e. a background context), a set of data layers (i.e. business specific data), an extent (i.e. the part of the Earth currently on the screen), and navigation tools to pan and zoom. A layer specifies how a geographic dataset is portrayed on the map or the globe. The final rendering supporting your use case can usually be assembled by adding a serie of layers.

A feature layer is a grouping of similar geographic elements, for example, buildings, cities, roads, earthquake epicenters, etc. Features can be points, lines, or polygons (i.e. vector data). Feature layers are most appropriate for visualizing your own data on top of your basemaps. Using Kano, you can view, save, edit and analyze your own features and their attributes. Moreover, you can include interactive pop-up windows with information about the features. Raster data, most commonly found in remotely sensed data, topographic data, satellite imagery, and aerial imagery, can also be visualized. For this, Kano can leverage OGC standards that use the internet to view, edit, manage and share geospatial data.

Kano manages both space and time information in order to visualize time-varying geospatial phenomena: tracking of moving objects, history of measures taken by a sensor, weather prediction over time, etc. When a layer displays a time-varying dataset you are able to navigate back and forward in time using a timeline to see the data at your requested date/time.

Global overview ​

The following figure depicts the default 2D activity and the main application components:

Components

TIP

The 3D view is pretty similar to the 2D activity except that some feature might not be yet available.

Each component can be shown/hidden through a handle on the different side of the view:

  • at the top to open the application bar,
  • at the bottom to open the timeline,
  • on the left to open the side/main menu,
  • on the right to open the catalog.

In addition, a floating action button is available in the bottom-right corner to perform some actions.

Check out now our quickstart guide for more details.

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/hashmap.json b/hashmap.json index d57e7019..94f7642f 100644 --- a/hashmap.json +++ b/hashmap.json @@ -1 +1 @@ -{"guides_installing-kano.md":"hypdee-x","guides_customizing-kano.md":"8nbTGQ9l","guides_installing-services.md":"dsJfA9g8","guides_kano-api.md":"n3Dtz0EC","about_license.md":"qdb0yiyt","guides_getting-started.md":"2GOoH2nF","about_introduction.md":"ZchEHfVq","guides_understanding-kano.md":"IWOf-sHQ","reference_api.md":"wWmT5Fzy","reference_configuration.md":"1lzXteaM","about_contact.md":"MLWlmPcp","about_contributing.md":"Q-A41HE2","guides_advanced-usage.md":"I8CO6hgM","index.md":"Xmx78NTg","about_roadmap.md":"Tsa-l91W"} +{"reference_api.md":"wWmT5Fzy","index.md":"Xmx78NTg","about_introduction.md":"ZchEHfVq","about_license.md":"qdb0yiyt","about_roadmap.md":"Tsa-l91W","guides_advanced-usage.md":"I8CO6hgM","guides_customizing-kano.md":"8nbTGQ9l","guides_getting-started.md":"2GOoH2nF","guides_installing-kano.md":"hypdee-x","reference_configuration.md":"1lzXteaM","guides_understanding-kano.md":"IWOf-sHQ","guides_installing-services.md":"dsJfA9g8","about_contact.md":"MLWlmPcp","about_contributing.md":"Q-A41HE2","guides_kano-api.md":"n3Dtz0EC"} diff --git a/index.html b/index.html index fb9a28ec..9957bac4 100644 --- a/index.html +++ b/index.html @@ -20,7 +20,7 @@
Kano

Appearance

Kano

A powerful real-time Geovisualizer

Show me more →
kalisio-kano

Powerful Geovisualizer

Kano supports advanced visualization capabilities in 2D and 3D thanks to hardware acceleration with WebGL technology

Real-time oriented

Driven by today’s most advanced web technologies, Kano enables real-time tracking of your geospatial assets

Designed to be integrated and customized

Through a single API, Kano provides users with the capability to develop geospatial applications

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/reference/api.html b/reference/api.html index 45a1f726..092088d7 100644 --- a/reference/api.html +++ b/reference/api.html @@ -20,7 +20,7 @@
Kano

Appearance

Backend API ​

The externally exposed API of the internal Kano services comes from the one provided by the KDK:

Frontend API ​

The externally exposed API of the internal Kano components (2D map and 3D globe) comes from the one provided by the KDK:

Similarly, most of the internal mapping components come from the KDK.

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file diff --git a/reference/configuration.html b/reference/configuration.html index 1132949b..220b5c65 100644 --- a/reference/configuration.html +++ b/reference/configuration.html @@ -20,7 +20,7 @@
Kano

Appearance

Configuration ​

The default backend configuration file can be found here.

Most options come from the "standard" backend configuration of KDK based app.

The default frontend configuration file can be found here.

Most options come from the "standard" frontend configuration of KDK based app, here are the main ones:

  • appName: displayed application name,
  • appLogo: displayed application logo,
  • theme: the theme to be used,
  • screens: connection screens configuration
    • banner: displayed application banner,
    • login: login screen configuration
      • providers: array of OAuth2 providers to be used (like ['google', 'github']),
      • links: links displayed at the bottom of the screen,
    • logout: logout screen configuration
      • links: links displayed at the bottom of the screen,
    • changeEndpoint: change endpoint screen configuration (only useful for mobile apps)
      • links: links displayed at the bottom of the screen,
  • layout: layout configuration (see Quasar docs for details)
    • topPane: application bar setup,
      • opener: true to add a handler to open/close the pane,
      • visible: true to show this pane,
    • leftPane: left pane (i.e. main menu) setup (as above),
    • bottomPane: bottom pane setup (as above),
    • rightPane: right pane setup (as above),
    • welcome: true to display the welcome screen by default,
  • mapActivity: 2D map activity configuration
    • topPane: application bar components configuration
      • content: list of components to be displayed according to current mode,
      • filter: component filter using any expression supported by sift,
    • leftPane: left pane (i.e. main menu) components configuration
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • bottomPane: bottom pane components configuration
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • rightPane: right pane components configuration
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • page: page components configuration (can be used to add your own components)
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • window: window (i.e. widgets) configuration
      • widgets: list of widgets to be displayed,
      • filter: component filter using any expression supported by sift,
    • fab: floating action button (FAB) configuration
      • actions: list of actions to be displayed,
      • filter: action filter using any expression supported by sift,
    • catalog: 2D map layers panel configuration
      • filter: layer filter using any expression supported by sift,
      • categories: list of categories to be displayed in 2D map layers panel,
    • layers: 2D map layers configuration
      • actions: list of actions to be displayed,
      • filter: action filter using any expression supported by sift,
    • restore: user context restoration configuration
      • view: set it to true (default) in order to restore the current extent on page refresh
      • layers: set it to true (false by default) in order to restore the current visible layers on page refresh
    • engine: 2D map view configuration
  • globeActivity: 3D globe activity configuration
    • topPane: application bar components configuration
      • content: list of components to be displayed according to current mode,
      • filter: component filter using any expression supported by sift,
    • leftPane: left pane (i.e. main menu) components configuration
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • bottomPane: bottom pane components configuration
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • rightPane: right pane components configuration
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • page: page components configuration (can be used to add your own components)
      • content: list of components to be displayed,
      • filter: component filter using any expression supported by sift,
    • window: window (i.e. widgets) configuration
      • widgets: list of widgets to be displayed,
      • filter: component filter using any expression supported by sift,
    • fab: floating action button (FAB) configuration
      • actions: list of actions to be displayed,
      • filter: action filter using any expression supported by sift,
    • catalog: 3D map layers panel configuration
      • filter: layer filter using any expression supported by sift,
      • categories: list of categories to be displayed in 3D map layers panel,
    • layers: 3D map layers configuration
      • actions: list of actions to be displayed,
      • filter: action filter using any expression supported by sift,
    • catalog: 3D globe layers panel configuration
      • filter: layer filter using any expression supported by sift,
      • categories: list of categories to be displayed in 3D globe layers panel,
    • restore: user context restoration configuration
      • view: set it to true (default) in order to restore the current extent on page refresh
      • layers: set it to true (false by default) in order to restore the current visible layers on page refresh
    • engine: 3D globe view configuration

MIT Licensed | Copyright © 2017-20xx Kalisio

- + \ No newline at end of file