PHYS Simulation API 1.0 documentation

Using PHYS Simulation API you can request simulations of some physical or mathematical systems such as the Harmonic Oscillator or the Chen-Lee Attractor –and soon many others, stay tuned!

History

PHYS Simulation API started as a way of learning to develop an API. We believe that the best way of learning is by doing. This way, we chose a topic that drives us (yes, physics and mathematics!) and started learning by writting code! Of course, we had to read a lot and fail a lot as well, but we managed to develop our very first web application and we are proud of it, as impefect as it may be.

In the future we want to add as many features as we can, so far it enriches the client experience.

Note

This project was also presented as Harvard’s CS50x final project. Check out the video.

Getting Started

• Overview

• Install and run locally

• Examples

• Website

For Developers

This API is built on top of FastAPI. If you want to contribute to this project, you may find their docs very useful.

In this section you can find all the source code docuentation. If you have a question on how some function, class or method works, maybe it’s answered here. If not, do not hesitate to contact us.

The Code

simulation_api

Initialization of web application.

simulation_api.controller

The core package of our API. Here you can find the main app, schemas and background tasks.

simulation_api.model

Database-related package.

simulation_api.simulation

Simulation-related package. Here you can find all the programs we use to simulate the available systems.

simulation_api.config

Configuration module. Some very basic configurations of our web application.

Indices and tables

• Index

• Module Index

• Search Page

A Special Aknowledgement

To Camilo Hincapié who guided me in this process.