In order to build Open MCT from source there are a number of prerequisites that you must have installed in your development environment. With the build prerequisites installed, Open MCT can be downloaded and built using the steps at right. Starting with an empty directory, these steps will check out Open MCT from github, build it, and run a local web server.
gitat a command prompt. If it’s not currently installed, you can download a git client from https://git-scm.com/downloads
1Clone the source code
2Install development Dependencies
3Run a local development server
A new API is currently under development that will deprecate much of the documentation and tutorials below, however Open MCT will remain compatible with the currently documented API. An updated set of tutorials is being developed with the new API, and currently covers how to register object and telemetry providers in the new API.
The new API moves away from a declarative system of JSON configuration files, and instead presents an imperative system based on function calls. Developers will be able to extend and build on Open MCT by making direct function calls to a public API. Open MCT is also being refactored to minimize the dependencies that using Open MCT imposes on developers, such as the current requirement to use Angular JS.
Broadly speaking, there are two types of telemetry sources that you might want to integrate with: Those that provide real-time streaming data, and those that provide historical data. The nature of the connections used to receive telemetry data (such as via HTTP request, or WebSockets) is not prescribed by Open MCT, nor is the format of the telemetry, and developers are encouraged to use the method that best suits their needs.
A tutorial is provided that gives an example of writing a telemetry provider and integrating with real-time and historical telemetry sources.
Open MCT can be extended to provide new ways of visualizing and interacting with data, while offering a consistent user experience. Plugins may utilize Open MCT's provided extension points to define new:
These extension points are not fully documented or implemented in the new API. This page will be updated as we continue to develop the documentation and related tutorials. If you are interested in trying out these extension points now, please contact us.
For more information on our timeline for updating the API and these documents, please check out the API Roadmap under Documentation
Open MCT is an open source project hosted on Github. To get started with Open MCT, see our Getting Started guide.
This is an opportunity to contribute in a tangible way to NASA's exploration of the solar system. Your contributions may potentially be used to study Mars, explore the poles of the Moon, or improve our understanding of the Earth. There are opportunities for coders and non-coders alike to contribute.
Before we can merge any code into our repository and potentially start using it on a mission, there is a Contributor License Agreement that must be completed.
Start here, young padawan: documentation and tutorials. The tutorials will take you through a number of common use-cases for extending Open MCT. We also have a contributor's guide that will take you through some of the specifics of submitting your own code to our repository.
When you're ready to start writing code, you can either start hacking away at your own ideas, or take a look at our Help Wanted list.
Absolutely. Try our software out, and let the world know about it. If you have any suggestions for improving it, find any bugs, know of novel ways of visualizing complex data, have outreach ideas, or anything else please let us know by filing an issue on Github or emailing us.
That's great! Please let us know if you are using Open MCT, we would love to hear about it. Are you using Open MCT for your mobile robotics project? Have you integrated it with Kerbal Space Program? Anything you do with Open MCT is of interest to us. Also, if you have created plugins, visualizations, bug fixes, or anything else in your own project based on Open MCT, we would love to incorporate them into our software. Please file a pull request!