Skip to content

Commit

Permalink
ODE-270 Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
hmusavi committed Dec 21, 2018
1 parent 1e3202d commit 6be50a1
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 2 deletions.
File renamed without changes.
34 changes: 32 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:https://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:https://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)


<a name="toc"/>

## Table of Contents
Expand Down Expand Up @@ -44,6 +73,7 @@ The ITS ODE is a real-time virtual data router that ingests and processes operat
<a name="documentation"/>

## 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)
Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit 6be50a1

Please sign in to comment.