v3 documentation

README.md

@@ -1,58 +1,75 @@
 # Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss
 # HIAS - Hospital Intelligent Automation Server
 
-[![HIAS - Hospital Intelligent Automation System](assets/images/project-banner.jpg)](https://github.com/AIIAL/HIAS-Core)
+[![HIAS - Hospital Intelligent Automation System](assets/images/project-banner.jpg)](https://github.com/aiial/hias-core)
 
-[![CURRENT RELEASE](https://img.shields.io/badge/CURRENT%20RELEASE-2.1.1-blue.svg)](https://github.com/AIIAL/HIASCDI/tree/2.1.1)
-[![UPCOMING RELEASE](https://img.shields.io/badge/CURRENT%20DEV%20BRANCH-3.0.0-blue.svg)](https://github.com/AIIAL/HIASCDI/tree/3.0.0)  [![LICENSE](https://img.shields.io/badge/LICENSE-MIT-blue.svg)](LICENSE) ![SemVer](https://img.shields.io/badge/semver-2.0.0-blue)
+[![CURRENT RELEASE](https://img.shields.io/badge/CURRENT%20RELEASE-3.0.0-blue.svg)](https://github.com/aiial/hias-core/tree/release-3.0.0) [![UPCOMING RELEASE](https://img.shields.io/badge/DEV%20BRANCH-develop-blue.svg)](https://github.com/aiial/hias-core/tree/release-3.0.0) [![Issues](https://img.shields.io/badge/Issues-Welcome-lightgrey.svg)](issues) [![Bug Reports](https://img.shields.io/badge/Bug%20Reports-Welcome-lightgrey.svg)](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=bug_report.md&title=) [![Contributions Welcome!](https://img.shields.io/badge/Contributions-Welcome-lightgrey.svg)](CONTRIBUTING.md)
 
-[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/)
+[![Documentation Status](https://readthedocs.org/projects/hias/badge/?version=latest)](https://hias.readthedocs.io/en/latest/?badge=latest) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5140/badge)](https://bestpractices.coreinfrastructure.org/projects/5140)
 
 ![Compliance Tests](https://img.shields.io/badge/Compliance%20Tests-TODO-red)
 ![Unit Tests](https://img.shields.io/badge/Unit%20Tests-TODO-red)
 ![Functional Tests](https://img.shields.io/badge/Functional%20Tests-TODO-red)
 
-[![Contributions Welcome!](https://img.shields.io/badge/Contributions-Welcome-lightgrey.svg)](CONTRIBUTING.md) [![Issues](https://img.shields.io/badge/Issues-Welcome-lightgrey.svg)](issues) [![Bug Reports](https://img.shields.io/badge/Bug%20Reports-Welcome-lightgrey.svg)](https://github.com/AIIAL/HIAS-Core/issues/new?assignees=&labels=&template=bug_report.md&title=)
+ [![LICENSE](https://img.shields.io/badge/LICENSE-MIT-blue.svg)](LICENSE) ![SemVer](https://img.shields.io/badge/semver-2.0.0-blue)
 
  
 
 # Introduction
+HIAS Core is an open-source server designed to control and manage a network of intelligent IoT connected devices and applications.
 
-HIAS Core is an open-source Hospital Automation Server designed to control and manage a network of intelligent IoT connected devices and applications. The server hosts a secure UI allowing the provisioning of HIAS devices and applications, managing and controlling the connected devices and applications, and reviewing/utilizing data collected from the network for automation.
+The goal is to create an open-source platform that can be used by hospitals, clinics, and other medical organizations to control and manage their devices and applications.
 
-![HIAS Network](assets/images/hias-network.jpg)
+The project is a work in progress and remains under development.
 
-Included in HIAS Core is a local MQTT and a local AMQP Broker providing secure machine to machine/application communication. The server also hosts a private Ethereum Blockchain used for permissions and data integrity, a private Context Broker (HIASCDI) based on the NGSI V2 specifications, and a private Historical Broker (HIASHDI). Network data is stored in the Historical and Context Brokers which utilize a private MongoDB database. This means that premises have more control and security when it comes to their hardware, data and storage.
+![HIAS Network](assets/images/hias-network-v3.jpg)
 
-HIAS Core also homes a facial recognition server and Natural Language Understanding Engine that act as a Intelligent Assistant, able to monitor and control devices in the location the server is installed in.
+HIAS Core is made up of the following primary components:
 
-All HIAS network devices run on the local network and are accessible via the internet through the HIAS Core secure reverse proxy or the secure m2m communication brokers. Network devices include AI Agents (Diagnostics, Facial Recognition/Identification, Natural Language Understanding etc), IoT devices (environment monitors, smart electronics etc), Virtual & Mixed Reality devices (Oculus Rift/Magic Leap) and Brain Computer Interfaces. All of these devices produce and consume historical and contextual data which is stored in HIAS Core and used to train AI models used to automate the management and control of HIAS network devices.
+- [HIASBCH](https://github.com/aiial/hiasbch) - A private Ethereum Blockchain
+- [HIASCDI](https://github.com/aiial/hiascdi) - A private NGSI v2 Context Broker
+- [HIASHDI](https://github.com/aiial/hiashdi) - A private Historical Data Broker
+- iotJumpWay:
+    - A Private MQTT Broker
+    - A Private AMQP Broker
+    - [HIAS MQTT IoT Agent](https://github.com/aiial/hias-mqtt-iot-agent)
+    - [HIAS AMQP IoT Agent](https://github.com/aiial/hias-amqp-iot-agent)
+    - [HIASBCH MQTT Blockchain Agent](https://github.com/aiial/hiasbch-mqtt-blockchain-agent)
 
-HIAS network devices and applications are a range of open-source, modular devices that can be provisioned via the HIAS UI, these devices are completely free, and include:
+HIAS network devices and applications are a range of open-source, modular devices and applications that can be provisioned via the HIAS UI. All HIAS compatible devices and applications have been developed by our volunteers and are completely open-source and free. These devices and applications currently include:
 
-- Medical diagnostics systems.
-- Data analysis systems.
-- Computer Vision and Natural Language Understanding systems.
-- Virtual and Mixed Reality systems
+- Medical diagnostics applications.
+- Data analysis applications.
+- Computer Vision and Natural Language Understanding.
+- Virtual and Mixed Reality applications.
 - Robotics.
-- Brain Computer Interfaces.
-- Users can also program their own devices and applications and connect them to the network.
+- Brain Computer Interface applications.
+
+Users can also program their own devices and applications and connect them to the network.
 
  
 
-# HIAS 3.0.0 Backware Incompatible
+# HIAS UI
 
-**HIAS 3.0.0 is backward incompatible and requires a completely fresh installation.**
+![HIAS UI - Dashboard](assets/images/hias-ui-dashboard.jpg)
 
-You can download and install the [current version (2.1.0)](https://github.com/AIIAL/HIAS-Core/tree/2.1.0) but please be aware that **3.0.0 requires a completely fresh installation.**.
+The HIAS UI is the central control panel for the HIAS server and network.
 
- 
+![HIAS UI - HIASBCH](assets/images/hias-ui-hiasbch.jpg)
+
+The UI provides the functionality to provision, manage, and monitor the HIAS network.
 
-# HIAS 3.0.0 Sneak Preview
+![HIAS UI - HIASBCH](assets/images/hias-ui-iot-agent.jpg)
+
+ 
 
-![HIAS 3.0.0 Sneak Preview](assets/images/hias-3.0.0-dashboard.jpg)
+# Get Started
+To get started follow the official HIAS Core documentation:
 
-![HIAS 3.0.0 Sneak Preview](assets/images/hias-3.0.0-dashboard-2.jpg)
+- [Installation Guide (Hyper-V)](https://hias.readthedocs.io/en/latest/installation/hyperv/)
+- [Installation Guide (Virtual Box)](https://hias.readthedocs.io/en/latest/installation/virtualbox/)
+- [Installation Guide (UBUNTU)](https://hias.readthedocs.io/en/latest/installation/ubuntu/)
+- [Usage Guide (UBUNTU)](https://hias.readthedocs.io/en/latest/usage/ubuntu/)
 
  
 
@@ -63,14 +80,14 @@ The Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Pet
 
 The following are ways that you can contribute to this project:
 
-- [Bug Report](https://github.com/AIIAL/HIASCDI/issues/new?assignees=&labels=&template=bug_report.md&title=)
-- [Feature Request](https://github.com/AIIAL/HIASCDI/issues/new?assignees=&labels=&template=feature_request.md&title=)
-- [Feature Proposal](https://github.com/AIIAL/HIASCDI/issues/new?assignees=&labels=&template=feature-proposal.md&title=)
-- [Report Vulnerabillity](https://github.com/AIIAL/HIASCDI/issues/new?assignees=&labels=&template=report-a-vulnerability.md&title=)
+- [Bug Report](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=bug_report.md&title=)
+- [Feature Request](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=feature_request.md&title=)
+- [Feature Proposal](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=feature-proposal.md&title=)
+- [Report Vulnerabillity](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=report-a-vulnerability.md&title=)
 
-Please read the [CONTRIBUTING](CONTRIBUTING.md "CONTRIBUTING") document for a full guide to forking our repositories and submitting your pull requests. You will also find information about our code of conduct on this page.
+Please read the [CONTRIBUTING](CONTRIBUTING.md "CONTRIBUTING") document for a full guide to forking our repositories and submitting your pull requests. You will find information about our code of conduct on the [Code of Conduct page](CODE-OF-CONDUCT.md "Code of Conduct page").
 
-You can also join in with, or create, a discussion in our [Github Discussions](https://github.com/AIIAL/HIASCDI/discussions) area.
+You can also join in with, or create, a discussion in our [Github Discussions](https://github.com/aiial/HIASCDI/discussions) area.
 
 ## Contributors
 

docs/index.md

@@ -0,0 +1,97 @@
+# Hospital Intelligent Automation Server
+
+[![HIAS - Hospital Intelligent Automation System](img/project-banner.jpg)](https://github.com/aiial/hias-core)
+
+# Introduction
+HIAS Core is an open-source server designed to control and manage a network of intelligent IoT connected devices and applications.
+
+The goal is to create an open-source platform that can be used by hospitals, clinics, and other medical organizations to control and manage their devices and applications.
+
+The project is a work in progress and remains under development.
+
+![HIAS Network](img/hias-network-v3.jpg)
+
+HIAS Core is made up of the following primary components:
+
+- [HIASBCH](https://github.com/aiial/hiasbch) - A private Ethereum Blockchain
+- [HIASCDI](https://github.com/aiial/hiascdi) - A private NGSI v2 Context Broker
+- [HIASHDI](https://github.com/aiial/hiashdi) - A private Historical Data Broker
+- iotJumpWay:
+    - A Private MQTT Broker
+    - A Private AMQP Broker
+    - [HIAS MQTT IoT Agent](https://github.com/aiial/hias-mqtt-iot-agent)
+    - [HIAS AMQP IoT Agent](https://github.com/aiial/hias-amqp-iot-agent)
+    - [HIASBCH MQTT Blockchain Agent](https://github.com/aiial/hiasbch-mqtt-blockchain-agent)
+
+HIAS network devices and applications are a range of open-source, modular devices and applications that can be provisioned via the HIAS UI. All HIAS compatible devices and applications have been developed by our volunteers and are completely open-source and free. These devices and applications currently include:
+
+- Medical diagnostics applications.
+- Data analysis applications.
+- Computer Vision and Natural Language Understanding.
+- Virtual and Mixed Reality applications.
+- Robotics.
+- Brain Computer Interface applications.
+
+Users can also program their own devices and applications and connect them to the network.
+
+ 
+
+# HIAS UI
+![HIAS UI - Dashboard](img/hias-ui-dashboard.jpg)
+
+The HIAS UI is the central control panel for the HIAS server and network.
+
+![HIAS UI - HIASBCH](img/hias-ui-hiasbch.jpg)
+
+The UI provides the functionality to provision, manage, and monitor the HIAS network.
+
+![HIAS UI - HIASBCH](img/hias-ui-iot-agent.jpg)
+
+ 
+
+# Get Started
+To get started follow the official HIAS Core documentation:
+
+- [Installation Guide (Hyper-V)](installation/hyperv.md)
+- [Installation Guide (Virtual Box)](installation/virtualbox.md)
+- [Installation Guide (UBUNTU)](installation/ubuntu.md)
+- [Usage Guide (UBUNTU)](usage/ubuntu.md)
+
+ 
+
+# Contributing
+The Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss encourages and welcomes code contributions, bug fixes and enhancements from the Github community.
+
+## Ways to contribute
+
+The following are ways that you can contribute to this project:
+
+- [Bug Report](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=bug_report.md&title=)
+- [Feature Request](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=feature_request.md&title=)
+- [Feature Proposal](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=feature-proposal.md&title=)
+- [Report Vulnerabillity](https://github.com/aiial/hias-core/issues/new?assignees=&labels=&template=report-a-vulnerability.md&title=)
+
+Please read the [CONTRIBUTING](https://github.com/aiial/hias-core/blob/master/CONTRIBUTING.md "CONTRIBUTING") document for a full guide to forking our repositories and submitting your pull requests. You will find information about our code of conduct on the [Code of Conduct page](https://github.com/aiial/hias-core/blob/master/CODE-OF-CONDUCT.md "Code of Conduct page").
+
+You can also join in with, or create, a discussion in our [Github Discussions](https://github.com/aiial/HIASCDI/discussions) area.
+
+## Contributors
+
+All contributors to this project are listed below.
+
+- [Adam Milton-Barker](https://www.leukemiaairesearch.com/association/volunteers/adam-milton-barker "Adam Milton-Barker") - [Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss](https://www.leukemiaresearchassociation.ai "Asociación de Investigacion en Inteligencia Artificial Para la Leucemia Peter Moss") President/Founder & Lead Developer, Sabadell, Spain
+
+ 
+
+# Versioning
+We use [SemVer](https://semver.org/) for versioning.
+
+ 
+
+# License
+This project is licensed under the **MIT License** - see the [LICENSE](https://github.com/aiial/hias-core/blob/master/LICENSE "LICENSE") file for details.
+
+ 
+
+# Bugs/Issues
+We use the [repo issues](https://github.com/aiial/hias-core/issues "repo issues") to track bugs and general requests related to using this project. See [CONTRIBUTING](https://github.com/aiial/hias-core/blob/master/CONTRIBUTING.md "CONTRIBUTING") for more info on how to submit bugs, feature requests and proposals.