The Model-Based Engineering Environment (MBEE) is a modeling collaboration software that integrates system models with multidisciplinary engineering data and tools. This enables system models to be a single-source of truth. MBEE allows for model data to be more accessible across disciplines and skill sets via web-based UI. The UI enables users to interact with system model data without needing to be a systems modeler.
MBEE's mission is to better communicate data across engineering organizations by implementing the core goals of model-based systems engineering through software tools. MBEE decreases ambiguity by making a single-source of truth for data more achievable through its RESTful API, extensible plugins, and distributed services.
MBEE's first dependency to get started is Node.js and NPM. NPM comes with Node.js; just install packages with NPM to get started. To start up MBEE, node version 10.15.0 or greater is required. See nodejs.org for information on Node.js.
MBEE's second dependency is Redis. Redis is used as the session manager. It stores cookies and auth tokens.
You will also need an instance of a document based database. MongoDB is the preferred database, but MBEE does support plug-n-play with different databases, as long as a database strategy has been defined. To view more information on the database abstraction layer and how to configure existing strategies, please visit the README in app/db.
- Clone the MBEE code by running:
git clone https://github.com/lmco/mbee.git. - Enter the directory with
cd mbee.
- Install dependencies and build by running
yarn installornpm install. - Run MBEE by running
node mbee start.
See the Flight Manual (source located at ./doc)
for all encompassing user manual of MBEE.
You can view the MBEE Flight Manual at the /doc/flight-manual route on a
running MBEE server.
Included MBEE documentation:
- Configuration
- Integrations
- Plugins
- Developer Guide
Swagger API documentation can be viewed at the /doc/api route.
JSDoc developer documentation can be viewed at the /doc/ route.
If an issue is identified in MBEE, please email [email protected]. Refer to SECURITY.md for more information as well as the PGP encryption key.