fprime-subtopology-tool

Tool to generate subtopology instances and interfaces for F Prime.

https://github.com/fprime-community/fprime-subtopology-tool

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (7.9%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Tool to generate subtopology instances and interfaces for F Prime.

Basic Info
  • Host: GitHub
  • Owner: fprime-community
  • License: apache-2.0
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 219 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 5
Created about 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License Citation

README.md

Subtopology AC: A tool to add subtopology instances to F Prime

This tool provides the ability to "instantiate" subtopologies within F Prime.

Topologies are models that represent the connections between instantiated components in a given project. A particularly interesting scope of topologies is the concept of "subtopologies", which aim to provide contained topologies for sets of behavior.

For example, an implementation of software behavior for a custom GPS would be a great usage of subtopologies in a project. A GPS could be a contained subsystem of the larger project.

In the current version of F Prime, the ability to make a subtopology exists. However, it's capabilities are limited in a few ways, notably:

  1. You can only have one "instance" of a subtopology. If you'd like to reuse a subtopology with different configurations or components, you have to write a new subtopology and use that.

  2. Subtopologies do not (yet) have formal interfaces. Thus, if a subtopology would like to provide an uninstantiated component (i.e., device specific like a HID), an end user of a subtopology would have to write in the subtopology their component instance.

The following tool is provided as an autocoder for F Prime, which takes syntactic sugar in the form of annotations in .fpp files and adds capabilities to subtopologies in F Prime.

Documentation

docs - Provides documentation for setting up this tool and further developing it

nasa/fprime/docs - Provides documentation for getting up and running with a subtopology using this tool

Owner

  • Name: F´ Community Organization
  • Login: fprime-community
  • Kind: organization
  • Location: Space

Citation (CITATION.cff)

cff-version: 1.2.0
title: F Prime Subtopology Autocoder
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Ali
    family-names: Mosallaei
    email: alimos@umich.edu
    affiliation: University of Michigan
    orcid: 'https://orcid.org/0000-0001-9015-0018'
  - name: The F Prime Framework Team
    location: JPL / California Institute of Technology
    alias: NASA JPL
    website: 'https://fprime.jpl.nasa.gov/'
    city: Pasadena
    country: CA
repository-code: 'https://github.com/fprime-community/fprime-subtopology-tool'

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 1
  • Total pull requests: 9
  • Average time to close issues: about 2 hours
  • Average time to close pull requests: 1 day
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.11
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 9
  • Average time to close issues: about 2 hours
  • Average time to close pull requests: 1 day
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.11
  • Merged pull requests: 8
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • mosa11aei (11)
Top Labels
Issue Labels
Pull Request Labels
enhancement (2)