_Author: Giacomo Luccisano. Please note that all the parser scripts are to be extensively tested and corrected. If you have any questions of want to signal a bug, you can [write me an e-mail](mailto:giacomo.luccisano@studenti.polito.it)_.
---
## Getting started
## Repository Structure
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
The files in this Repository are organized as follows:
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
-[doc](./doc/) contains all documentation analyzed and produced
-[bib](./doc/bib/) collects all reference documents
-[report](./doc/report/) contains the latest version of the report with LaTeX and pdf files
-[gaphor_parser](./gaphor_parser/) has the python scripts for the Gaphor - Python parser
-[tutorial](./gaphor_parser/tutorial/) contains a tutorial ([here](./gaphor_parser/tutorial/README.md)) on how to run the parser and how to generate a `.gaphor` model
-[models](./models/) collects all the sysml models and tests
-[python_scripts](./python_scripts/) collects the mission analysis scripts
## Add your files
---
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://gitlab.isae-supaero.fr/preliminary-design/mbse-cubesat-sysml/-/settings/integrations)
**AFTER installing Conda** ([here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) the download options) from the current folder you can run:
## Collaborate with your team
```
cd gaphor_parser # move to gaphor_parser directory
# you should be in repo_installation_dir/gaphor_parser
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
conda install -c anaconda pyyaml
conda install pip
pip install graphviz
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
python3 gaphorParser.py -h # for some help...
***
# run the parser with heo_model example
# outputs will be generated in the outputs/ directory
If everything runs correctly you should have in your `modelOutDir` directory the following structure:
-`requirements_list.html` table with all requirements listed and alphabetically ordered;
-`table.css` style sheet for `requirements_list.html`, you can customise that as you wish;
-`relationGraph.gv` and `relationGraph.gv.pdf`**still WIP**, generated with [Graphviz](https://graphviz.org/) library, highlights the relationships between variables, to better understand what is affected by a change in the model;
-`components` folder:
-`CommSys.yaml` with transmitter and receiver data;
-`EPS.yaml` with solar array and battery data;
-`GroundStation.yaml` with GS location and antenna data;
-`OperatingMode.yaml` with the definition of the S/C operating modes;
-`Orbit.yaml` with orbital parameters;
-`PropagationLosses.yaml` self explanatory I guess;
-`SystemComp.yaml` with a list of all elements with `SystemComp` _stereotype_ applied. They are the components of the main systems (e.g., thrusters of the Propulsion System);
-`SystemMain.yaml` same as `SystemComp.yaml`, but with the parents Systems properties (e.g., Propulsion System, Payload, ...);
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
### Dependencies
:one: For the mission analysis python scripts, everything can be found in [this folder](./python_scripts/) of the repository. It also includes the code main dependencies as NASA GMAT and the Gaphor parser itself.
## Name
Choose a self-explaining name for your project.
:exclamation: Remember to change the paths references in the `CONFIG_input.yaml` file [here](./python_scripts/Data/) and in the `runMissionFromPythonInDocker` function inside the `functionsDatabase.py`. Everyhing should be straight forward.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
:three: Docker is needed for the correct execution of the `generalMissionAnalysis.py`. [Here](https://docs.docker.com/engine/install/) the instructions. It is available for Windows, Mac and Linux. A Desktop version is available [here](https://docs.docker.com/get-docker/).
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
### Execution
Once all the previous points are done, from the main folder you can execute in the terminal:
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
**Only for the first time, Docker image generation**
```
cd <repo_path>/python_scripts/dependencies/GMAT_Application && docker build -t gmat:gui .
```
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
:exclamation: note that the `.` after `gmat:gui` is mandatory, or the Docker image won't be generated. If you did everything correctly, you should have a `gmat:gui` image waiting to be run.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
**After Docker image generation**
Make sure to replace the paths indicated in point :one:. After that you can run, from the current folder:
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
```
cd python_scripts # move to python_scripts directory
# you should be in <repo_path/python_scripts>
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
python --version # check your python version
# Python >= 3.10 is needed
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
conda create --name gaphor python=3.10.12
conda activate gaphor
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
conda install -c anaconda pyyaml
conda install pip
pip install graphviz
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
# run the mission analysis tool with heo_model example
# make sure that the runGaphorParser and runGmat variables in the generalMissionAnalysis.py are set to True
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
python3 generalMissionAnalysis.py
## License
For open source projects, say how it is licensed.
# parser outputs will be generated in the gaphor_parser_out/ directory
# data and power budgets will be generated in the Output_Lite directory
```
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
:exclamation: If everything runs correctly, you should have in `Output_Lite/Figures` a `BatteryRemainingPower` and a `DataBudget` files, and in `gaphor_parser_out/` the above mentioned parser outputs.
