add back requirements.txt and update README

This commit is contained in:
Robin Müller 2022-05-17 14:55:23 +02:00
parent cff6661f5d
commit 1272a5aa89
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC
2 changed files with 64 additions and 46 deletions

109
README.md
View File

@ -4,15 +4,76 @@ This application can be used to test the EIVE On-Board Software. Furthermore, it
also be used to retrieve all sorts of telemetry data like housekeeping data. also be used to retrieve all sorts of telemetry data like housekeeping data.
It is recommended to use this application with a virtual environment. It is recommended to use this application with a virtual environment.
The [virtual environemnt](#venv) chapter describes how to set one up. The [virtual environemnt](#venv) chapter describes how to set one up and install the `tmtccmd`
package interactively.
The configuration file can currently be found at `tmtc_conf.json`. It caches settings The configuration file can currently be found at `tmtc_conf.json`. It caches settings
like the default communication interface or parameters like the TCP port when using the TCP like the default communication interface or parameters like the TCP port when using the TCP
communication interface. communication interface.
# <a id="venv"></a> Set up virtual environment
## Linux
1. Create virtual environment
```sh
python3 -m venv venv
```
2. Activate virtual environment
```sh
. venv/bin/activate
```
## Windows
1. Create virtual environment
```sh
py -m venv .
```
2. Activate virtual environment
```sh
venv\Scripts\activate.bat
```
# Install requirements
There are two ways to install the requirements. One is to install the primary dependency
`tmtccmd` interactively. This is the recommended way
Assuming you are running in a virtual environment:
1. Install `tmtccmd` for virtual environment. `-e` for interactive installation.
```sh
cd tmtccmd
pip install -e .[gui]
```
2. You can also install the `spacepackets` package locally/interactively
Normally, it will be installed as a `tmtccmd` dependency.
```sh
cd spacepackets
pip install -e .
```
Alternatively you can also install the packages from PyPI completely, but the risk of
incompatibilities will be high there
```sh
pip install -r requirements.txt
```
# Examples # Examples
Assuming you are running in a virtual environment Assuming you are running in a virtual environment and all package requirements were
installed properly.
Run CLI mode Run CLI mode
@ -45,47 +106,3 @@ and then run the `lint.py` script
```sh ```sh
./lint.py ./lint.py
``` ```
# <a id="venv"></a> Set up virtual environment
## Linux
1. Create virtual environment
```sh
python3 -m venv venv
```
2. Activate virtual environment
```sh
. venv/bin/activate
```
3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.
```sh
cd tmtccmd
python3 -m pip install -e .[gui]
```
## Windows
1. Create virtual environment
```sh
py -m venv .
```
2. Activate virtual environment
```sh
venv\Scripts\activate.bat
```
3. Install `tmtccmd` for virtual environment. `-e` for interactive installation.
```sh
cd tmtccmd
py -m pip install -e .[gui]
```

1
requirements.txt Normal file
View File

@ -0,0 +1 @@
tmtccmd >= 2.2.1