From 6be50a1cd42eca8882858b5dcaaacabf8d3b261d Mon Sep 17 00:00:00 2001 From: Hamid Musavi Date: Fri, 21 Dec 2018 09:48:24 -0500 Subject: [PATCH] ODE-270 Updated README --- ATTRIBUTION.txt => ATTRIBUTION.md | 0 README.md | 34 +++++++++++++++++++++++++++++-- 2 files changed, 32 insertions(+), 2 deletions(-) rename ATTRIBUTION.txt => ATTRIBUTION.md (100%) diff --git a/ATTRIBUTION.txt b/ATTRIBUTION.md similarity index 100% rename from ATTRIBUTION.txt rename to ATTRIBUTION.md diff --git a/README.md b/README.md index 92c9865b2..c5ee1052a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,45 @@ + Master: [![Build Status](https://travis-ci.org/usdot-jpo-ode/jpo-ode.svg?branch=master)](https://travis-ci.org/usdot-jpo-ode/jpo-ode) [![Quality Gate](https://sonarcloud.io/api/badges/gate?key=usdot.jpo.ode:jpo-ode)](https://sonarcloud.io/dashboard?id=usdot.jpo.ode%3Ajpo-ode) Develop: [![Build Status](https://travis-ci.org/usdot-jpo-ode/jpo-ode.svg?branch=develop)](https://travis-ci.org/usdot-jpo-ode/jpo-ode) [![Quality Gate](https://sonarcloud.io/api/badges/gate?key=usdot.jpo.ode:jpo-ode:develop)](https://sonarcloud.io/dashboard?id=usdot.jpo.ode%3Ajpo-ode%3Adevelop) # jpo-ode -US Department of Transportation (USDOT) Intelligent Transportation Systems Operational Data Environment (ITS ODE) +**US Department of Transportation (USDOT) Intelligent Transportation Systems (ITS) Joint Program Office (JPO)** +## Open Source Overview The ITS ODE is a real-time virtual data router that ingests and processes operational data from various connected devices - including vehicles, infrastructure, and traffic management centers - and distributes it to other devices and subscribing transportation management applications. Using the ITS ODE within intelligent transportation deployments increases data fluidity and interoperability while meeting operational needs and protecting user privacy. The software’s microservices architecture makes it easy to add new capabilities to meet local needs. ![ODE Dataflows](images/data_flow_v2.png) +### License information + +Licensed under the Apache License, Version 2.0 (the "License"); you may not use this +file except in compliance with the License. +You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 +Unless required by applicable law or agreed to in writing, software distributed under +the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or implied. See the License for the specific language governing +permissions and limitations under the [License](http://www.apache.org/licenses/LICENSE-2.0). + +### System Requirements +Minimum memory: 16 GB +Minimum Storage Space: 100 GB +Operating systems supported: Ubuntu Linux + +The ODE software can run on most standard Window or Linux based computers with +Pentium core processors, with at least 16 gigabytes of RAM and at least 100 GB of drive space. +Performance of the software will be based on the computing power and available RAM in +the system. Larger data flows can require much larger space requirements depending on the +amount of data being processed by the software. The ODE software application was developed using the open source programming language Java. The application requires Java 8 or higher to run. The application can be run on Windows, Linux, or Mac operating systems. + +### Web sites +https://www.its.dot.gov/factsheets/pdf/ITSJPO_ODE.pdf +Application Support: ODE application support is currently manage via GitHub issue tracking: https://github.com/usdot-jpo-ode/jpo-ode/issues + +### [Attribution](ATTRIBUTION.md) + + ## Table of Contents @@ -44,6 +73,7 @@ The ITS ODE is a real-time virtual data router that ingests and processes operat ## II. Documentation + ODE provides the following living documents to keep ODE users and stakeholders informed of the latest developments: 1. [ODE Architecture](docs/JPO%20ODE%20Architecture.docx) @@ -342,7 +372,7 @@ Install the IDE of your choice: * TravisCI: https://travis-ci.org/usdot-jpo-ode/jpo-ode -### Continous Deployment +### Continuous Deployment To be added.