Git Product home page Git Product logo

rrosace's Introduction

GitHub version Build Status GitHub issues GitHub forks GitHub stars GitHub license

RROSACE

Scheduling of a Cyber-physcal system simulation -- Cyber-physical models library.

Description

rrosace_pic

This project is a simple longitudinal flight loop โœˆ๏ธ based on the ROSACE case study. Links ๐Ÿ”— to the case study, and some implementations, are available below.

RROSACE adds redundancy to ROSACE controllers, in order to highlight scheduling problems.

This project was used as part of a CIFRE PhD thesis ๐ŸŽ“ involving ISAE-SUPAERO and Airbus to illustrate the simulation scheduling of cyber-physical systems.

Table of Contents

1. Usage

1.1. Cloning this repo

This repo is available at ๐Ÿ”— hnrck/rrosace.

Cloning can be done in HTTPS mode:

$ git clone https://github.com/hnrck/rrosace
$ git checkout tags/1.3.0

or with ssh mode:

$ git clone [email protected]:hnrck/rrosace.git
$ git checkout tags/1.3.0

1.2. Testing the implementation

The compilation of the library can be test using the following command:

$ make test

Please feel free to report problems with your tests.

1.3. Generating the documentation

$ make doc

The documentation can be opened in a browser, or generated in PDF from LaTeX sources.

For browser based navigation, open build/doc/html/index.html For generating PDF, do:

$ make -C build/doc/latex

Generated PDF will be build/doc/latex/refman.pdf

1.4. Building and using the project

In order to build the project, use the following command:

$ make 

Project can be install with:

$ make install

By default, the installation is local. Installed headers and libraries can be used sourcing the local rrosacepathsrc: install/etc/rrosace/rrosacepathsrc This can be done using:

$ source install/etc/rrosace/rrosacepathsrc

Absolute path can be deduced and sourced directly before use, for instance in dev environment in any .{bash,zsh,...}rc.

$ source <path/to/rrosace>/install/etc/rrosace/rrosacepathsrc

Furthermore, while installing, the absolute path of the rrosacepathsrc is given:

...
-- Installing: <path/to/rrosace>/install/etc/rrosace/rrosacepathsrc

After installation and sourcing, rrosace library can be used as any library. Compilation using rrosace library while need linking, using -lrrosace.

The installation can be checked using the simple loop example.

$ make check_install

The following integration of component is recommended, and used in the loop example: rrosace_components

1.5. Other targets

Cleaning the repo:

make clean

Static check on source code (requires clang-tidy):

make lint

Formatting of source code (requires clang-format):

make format

Building / running a simple loop example:

make example_loop
make run_example_loop

1.6. Alternative builds and configurations

It is possible to directly use cmake to build the project, feel free to based your command on the targets in the Makefile

Furthermore, compilation options are possible from the environment, set the following variable in you shell or before your command:

$ export <VAR>=<my option>
$ make

or

$ <VAR>=<my option> make
option VAR default value alternatives
C compiler CC clang gcc, icc, ...
C++ compiler CXX clang++ g++, ...
C++ standard CXXSTD 98 11, 14
Generator GENERATOR Ninja Unix Makefile, ...
Build type BUILD_TYPE RelWithDebInfo Release, Debug, MinSizeRel
Build directory BUILD_DIR build anywhere
Install directory INSTALL_DIR install anywhere
Activate/Deactivate C++ check CPPCHECK 1 (activate) 0 (deactivate)

2. Related work

RROSACE is based on the Open Source ROSACE (Research Open-Source Avionics and Control Engineering) case study.

3. Project structure

.
โ”œโ”€โ”€ ChangeLog.md
โ”œโ”€โ”€ cmake-extra-modules
โ”‚ย ย  โ””โ”€โ”€ *.cmake
โ”œโ”€โ”€ CMakeLists.txt
โ”œโ”€โ”€ doc
โ”‚ย ย  โ””โ”€โ”€ Doxyfile.in
โ”œโ”€โ”€ examples
โ”‚ย ย  โ””โ”€โ”€ *
โ”‚ย ย      โ””โ”€โ”€ {Makefile,*.{h,c,cpp}}
โ”œโ”€โ”€ include
โ”‚ย ย  โ””โ”€โ”€ rrosace{-*}.h
โ”œโ”€โ”€ LICENSE
โ”œโ”€โ”€ Makefile
โ”œโ”€โ”€ README.md
โ”œโ”€โ”€ res
โ”‚ย ย  โ””โ”€โ”€ *
โ”œโ”€โ”€ src
โ”‚ย ย  โ””โ”€โ”€ *.c
โ”œโ”€โ”€ test
โ”‚ย   โ””โ”€โ”€ *.{h,c,cpp}
โ””โ”€โ”€ VERSION

Important folders:

  • include - the rrosace headers.
  • src - the sources of the rrosace library.
  • test - the rrosace tests folders.
  • examples - the rrosace examples folders, each example has a dedicated folder.

Important files:

  • README.md - this file.
  • LICENSE - the license file.
  • VERSION - the current version of the library.
  • ChangeLog.md - list of changes between revisions.
  • CMakeLists.txt - the project configuration file
  • Makefile - helper for compilation and installation.

4. Contributing

Contributions are welcome ๐Ÿ”“. Feel free to fork too ๐Ÿด.

5. Credits

6. License

This work is under the MIT License. ยฉ๏ธ Henrick Deschamps, 2019.

rrosace's People

Contributors

hnrck avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.