Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added a configuration file and library #62

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

waridh
Copy link
Contributor

@waridh waridh commented Jul 14, 2024

#44 #61

Included

  • A Python helper library that takes the path to the config file, and the subsystem of interest, and returns a dictionary with the settings needed. For now, the only field is the port.
  • A configuration file of the .ini format. Chosen for ease of modification.
  • A definitions.py that contains immutable shared values. Most notable is a dynamic absolute path of the project root (It will be the correct location on any machine thanks to pathlib.Path).
  • Simple Pytest tests for this helper library.
  • Basic documentation on how to use the microlibrary, and write new pytest tests.

The simulated subsystems are now able to grab their configuration from
the project root (simulated_config.ini)
@waridh waridh added the enhancement New feature or request label Jul 14, 2024
@waridh waridh self-assigned this Jul 14, 2024
@waridh waridh requested review from jac4e and kulovac July 16, 2024 22:40
Copy link
Member

@dheadrick1618 dheadrick1618 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! This is a good starting point for us moving forward with testing the sim subsystems.

System tests however will be tricky with the OBC FSW interacting with the simulated subsystems.

simulated_config.ini Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

Single file in project root directory with mention of each port in use and a description of its use.
2 participants