https://github.com/nunorc/sim-ops

Software suite for Spacecraft Operations simulations exercises.
https://github.com/nunorc/sim-ops

Last synced: about 1 month ago
JSON representation

Software suite for Spacecraft Operations simulations exercises.

• Host: GitHub
• URL: https://github.com/nunorc/sim-ops
• Owner: nunorc
• License: gpl-3.0
• Created: 2024-05-26T18:07:32.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-07-02T16:16:19.000Z (11 months ago)
• Last Synced: 2025-04-09T21:54:46.691Z (about 1 month ago)
• Language: Vue
• Size: 2.81 MB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        

# Sim-Ops

Sim-Ops is software suite for running spacecraft operations simulations exercises and demonstrations. It includes

a minimalist spacecraft simulator, a ground station simulator and a Monitoring and Control System (MCS).

Note, that the software suite is under constant development so things change fast. The following video

illustrates the MCS UI.

https://github.com/nunorc/sim-ops/assets/118554/2ff0d284-ef00-4299-83dd-374d9f3339cc

Repository content:

* `sim-ops-lib/`: Python packages to run in the background, including API and simulators.

* `sim-ops-mcs/`: MCS frontend interface.

* `containers/`: containers files and configurations.

The following scripts are required to be running:

* `so-master.py`: the master script managing the simulations in the background.

* `so/api.py`: the API required for the web interface.

### Run using Docker

Run using [Docker](https://www.docker.com/) containers, recommended, make sure to set the required

content in the `.env` file, or by using the option `--env-file`, for example to use the `.env.local` run:

    sim-ops$ docker compose --env-file .env.local build

    sim-ops$ docker compose --env-file .env.local up

    # mcs is available from http://localhost:8080

The default credentials for the basic authentication are:

    Username: sim

    Password: ops

The default password for the admin section in the MCS is `admin`.

In case you are running behind a reverse proxy, firewall, or any similar setting you may need to update the values

described in `.env.local` to your needs.

### Run from the command line

A Python (version 3.11 recommended) needs to be available, the list of required packages is available from `sim-ops-lib/requirements.txt` file.

**Note** A MQTT service, e.g. [Eclipse Mosquitto](https://mosquitto.org/) to run the scripts from a command line, check `containers/mqtt/config/mosquitto.conf` for an example configuration

Once an MQTT is running and reachable and all the requirements installed, run:

    # setup environment variables (required for all scripts and npm)

    sim-ops$ . scripts/export-env.sh .env.local

    sim-ops$ cd sim-ops-lib

    # run master script

    sim-ops-lib$ python so-master.py

    # run api

    sim-ops-lib$ uvicorn so.api:app

    sim-ops$ cd sim-ops-mcs

    

    # run mcs

    sim-ops-mcs$ npm run dev

    # mcs is available from http://localhost:5173

Running Python lib tests:

    $ cd sim-ops-lib

    sim-ops-lib$ pytest

### The Sim-Ops Team

Nuno Carvalho, Peter Stöferle, Adrian Calleja, Vladimir Zelenevskiy, Rodrigo Laurinovics, Marcin Kovalevskij, Tim Oerther, Frederik Dall'Omo, Guilhem Honore and David Evans.

### Acknowledgements

MCS UI theme based on HUD Vue by Sean Ngu.