Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rocketpy-team/infinity-api
Infinity-API is a RESTful Open API for RocketPy
https://github.com/rocketpy-team/infinity-api
aerodynamics api flight-simulator public-api rocket-simulator
Last synced: about 1 month ago
JSON representation
Infinity-API is a RESTful Open API for RocketPy
- Host: GitHub
- URL: https://github.com/rocketpy-team/infinity-api
- Owner: RocketPy-Team
- License: mit
- Created: 2023-04-29T21:17:07.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-04T14:48:43.000Z (about 2 months ago)
- Last Synced: 2024-11-04T15:46:41.996Z (about 2 months ago)
- Topics: aerodynamics, api, flight-simulator, public-api, rocket-simulator
- Language: Python
- Homepage: https://api.rocketpy.org
- Size: 345 MB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Infinity-API
## Capabilities
- Performs rocket simulations and returns simulation data
- Stores simulation input data in mongo-db
## Setup
- [Install python3](https://www.python.org/downloads/) 3.11.5 or above
- [install mongodb-atlas](https://www.mongodb.com/try/download/community)
- Install dependencies `python3 -m pip install -r requirements.txt`
## Development
- black ./lib
- pylint --extension-pkg-whitelist='pydantic' ./lib/*
- flake8 --ignore E501,E402,F401,W503 ./lib
## Starting the server
- Setup MONGODB_CONNECTION_STRING:
```
$ touch .env && echo MONGODB_CONNECTION_STRING="$ConnectionString" > .env
```
### Docker
- run docker compose: `docker-compose up --build -d`
### Standalone
- Dev: `python3 -m uvicorn lib:app --reload --port 3000`
- Prod: `gunicorn -k uvicorn.workers.UvicornWorker lib:app -b 0.0.0.0:3000`
## Project structure
```
├── README.md # this file
├── requirements.txt
│
├── lib
│ │
│ ├── api.py # main app
│ │── secrets.py
│ │
│ ├── controllers
│ │ ├── environment.py
│ │ ├── flight.py
│ │ ├── motor.py
│ │ └── rocket.py
│ │
│ ├── services
│ │ ├── environment.py
│ │ ├── flight.py
│ │ ├── motor.py
│ │ └── rocket.py
│ │
│ ├── routes
│ │ ├── environment.py
│ │ ├── flight.py
│ │ ├── motor.py
│ │ └── rocket.py
│ │
│ ├── repositories
│ │ ├── repo.py
│ │ ├── environment.py
│ │ ├── flight.py
│ │ ├── motor.py
│ │ └── rocket.py
│ │
│ ├── models
│ │ ├── aerosurfaces.py
│ │ ├── environment.py
│ │ ├── flight.py
│ │ ├── motor.py
│ │ └── rocket.py
│ │
│ └── views
│ ├── environment.py
│ ├── flight.py
│ ├── motor.py
│ └── rocket.py
│
└── tests
├── integration
│ ├── test_environment_integration.py
│ ├── test_motor_integration.py
│ ├── test_rocket_integration.py
│ └── test_flight_integration.py
│
└── unit
├── test_secrets.py
├── test_api.py
│
├── test_controllers
│ ├── test_environment_controller.py
│ ├── test_flight_controller.py
│ ├── test_motor_controller.py
│ └── test_rocket_controller.py
│
├── test_services
│ ├── test_environment_service.py
│ ├── test_flight_service.py
│ ├── test_motor_service.py
│ └── test_rocket_serice.py
│
├── test_routes
│ ├── test_environment_route.py
│ ├── test_flight_route.py
│ ├── test_motor_route.py
│ └── test_rocket_route.py
│
├── test_repositories
│ ├── test_environment_repo.py
│ ├── test_flight_repo.py
│ ├── test_motor_repo.py
│ └── test_rocket_repo.py
│
├── test_models
│ ├── test_environment_model.py
│ ├── test_flight_model.py
│ ├── test_motor_model.py
│ └── test_rocket_model.py
│
└── test_views
├── test_environment_view.py
├── test_flight_view.py
├── test_motor_view.py
└── test_rocket_view.py
```
## DOCS
- OpenAPI standard: [https://api.rocketpy.org/redoc](https://api.rocketpy.org/redoc)
- Swagger UI: [https://api.rocketpy.org/docs](https://api.rocketpy.org/docs)
## API Flowchart
General API workflow. Current available models are: Environment, Flight, Rocket and Motor.
### CRUD
```mermaid
sequenceDiagram
participant User
participant API
participant MongoDB
User ->> API: POST /model
API ->> MongoDB: Persist API Model as a document
MongoDB -->> API: Model ID
API -->> User: ModelCreated View
User ->> API: GET /model/:id
API ->> MongoDB: Read API Model document
MongoDB -->> API: API Model document
API -->> User: API ModelView
User ->> API: PUT /model/:id
API ->> MongoDB: Update API Model document
API -->> User: ModelUpdated View
User ->> API: DELETE /model/:id
API ->> MongoDB: Delete API Model document
MongoDB -->> API: Deletion Confirmation
API -->> User: ModelDeleted View
```
### Simulating and extracting RocketPY native classes
```mermaid
sequenceDiagram
participant User
participant API
participant MongoDB
participant Rocketpy lib
User ->> API: POST /summary/model/:id
API -->> MongoDB: Retrieve Rocketpy native class
MongoDB -->> API: Rocketpy native class
API ->> Rocketpy lib: Simulate Rocketpy native class
Rocketpy lib -->> API: Simulation Results
API -->> User: Simulation Results
User ->> API: POST /rocketpy/model/:id
API -->> MongoDB: Retrieve Rocketpy Model
MongoDB -->> API: Rocketpy Model
API ->> Rocketpy lib: Rocketpy Model
Rocketpy lib -->> API: Rocketpy native class as .dill binary
API -->> User: Rocketpy native class as .dill binary
```