https://github.com/zenitheesc/report-maker

Open-source software developed to ease the creation of reports related to the group Zenith Aerospace (EESC-USP).
https://github.com/zenitheesc/report-maker

documentation latex python software

Last synced: 7 months ago
JSON representation

Open-source software developed to ease the creation of reports related to the group Zenith Aerospace (EESC-USP).

Host: GitHub
URL: https://github.com/zenitheesc/report-maker
Owner: zenitheesc
License: mit
Created: 2020-05-27T16:54:09.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-10-03T21:42:49.000Z (over 2 years ago)
Last Synced: 2025-04-13T23:55:41.930Z (9 months ago)
Topics: documentation, latex, python, software
Language: Python
Homepage: http://zenith.eesc.usp.br/wp/
Size: 5.63 MB
Stars: 3
Watchers: 1
Forks: 2
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Report Maker

An automation tool designed to make the report production easier due to the automatization of the space log parsing and graphic generation

Environment and Tools •
Steps to run and debug •
How to contribute?

## Environment and tools

In this project, our three main goals were:
1. Create a versatile and modular parser dedicate to parse any Zenith Aerospace log;
2. Generate charts based on the data and eliminate outliers;
3. Generate a LaTeX report with the data provided by the parser.

Moreover, all these goals should've been achieved in a user-friendly GUI.

Due to the versatility, we picked **Python** as your primary development language. Report Maker's parser was developed using regular expression (**RegEx**) knowledge. The statistics stage was developed with famous **data science** libraries such as Pandas, Matplotlib, and Numpy. This stage also made it possible to generate maps when the log has geographic coordinates. At last, the pylatex library was used to generate a **LaTeX** file.
As many Report Maker's users are not programmers, we built a GUI with a Python native module, **Tkinter**.

## Steps to run and debug

First of all, you must have [python3](/www.python.org/downloads/) (with pip) installed. With you have already completed this requirement, then run the following command in the terminal:

```
git clone https://github.com/zenitheesc/Report_Maker.git
```

If you're using a **Windows** machine, just click on **Run.bat** and you should be good to go. But, if you're using **Linux/OSX** machine or a **virtual environment** such as conda, then run the following commands in the terminal:

```
python3 -m pip install -r requirements.txt
python3 main.py
```

## How to contribute

We love when new people come and help us to improve our software! If you want to contribute to this project, check our Projects board and pick an idea to develop. When you finish coding, make a clear and descriptive **pull request** explaining your modifications.

If you find any sort of problem or have a suggestion to the project, please write an **issue** and we will be pleased to help you!

### Developers

| [
_@jorgemrisco](https://github.com/jorgemrisco) | [
_@leocelente](https://github.com/leocelente) | [
_@mairacanal](https://github.com/mairacanal)
| :---: | :---: | :---: |
---