Initial commit

Author: banghuazhao

.github/.workflows/ci.yml

@@ -0,0 +1,38 @@
+name: Python FastAPI CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Check out the code from the repository
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      # Set up Python environment
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.7'  # Or whichever version your project requires
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m venv venv
+          source venv/bin/activate
+          pip install --upgrade pip
+          pip install -r requirements.txt
+
+      # Run tests
+      - name: Run tests
+        run: |
+          source venv/bin/activate
+          PYTHONPATH=./ pytest

.gitignore

@@ -0,0 +1,80 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Virtual Environment
+venv/
+env/
+ENV/
+.venv/
+
+# VS Code settings
+.vscode/
+.code-workspace
+
+# Test cache, coverage, and logs
+.pytest_cache/
+.coverage
+coverage.xml
+*.cover
+*.log
+.cache
+nosetests.xml
+coverage/
+htmlcov/
+.tox/
+.junit/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# MacOS specific files
+.DS_Store
+
+# Temporary files and backups
+*.bak
+*.swp
+*.tmp
+*~
+
+# Python virtual environment
+# Ignore this folder since you already have venv
+venv/
+
+# Environment Variables
+.env
+.env.*
+
+# Fastlane
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots/**/*.png
+fastlane/test_output/
+
+# JetBrains IDEs (optional, if using)
+.idea/
+*.iml

README.md

@@ -0,0 +1,113 @@
+# SwiftComp-API
+
+**SwiftComp-API** is a FastAPI-based backend designed to perform calculations related to composite laminate materials. It exposes various endpoints for computing engineering constants, plate properties, 3D laminate properties, and more. This API is suitable for researchers, engineers, and developers working in composite materials and structural analysis.
+
+## Table of Contents
+
+- [Features](#features)
+- [Technologies](#technologies)
+- [Installation](#installation)
+- [API Documentation](#api-documentation)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Features
+
+- **Versioned API:** Support for multiple versions of the API, with versioning (v1, v2) for backward compatibility.
+- **Material Property Calculations:** Endpoints to calculate various laminate engineering constants and composite properties.
+- **Lightweight & Fast:** Built using FastAPI, ensuring high performance and minimal latency.
+- **Modular Architecture:** Separation of concerns using routers, services, and utility functions for better maintainability.
+- **Extensible:** Easy to add new endpoints and services for additional material computations.
+
+---
+
+## Technologies
+
+- **FastAPI**: A modern, fast (high-performance) web framework for building APIs with Python 3.7+ based on standard Python-type hints.
+- **Python 3.7**: Programming language used to implement the logic.
+- **Pytest**: A robust testing framework for Python.
+- **Uvicorn**: ASGI server used for serving FastAPI applications.
+- **Virtual Environment (venv)**: For dependency isolation.
+
+---
+
+## Installation
+
+To set up the project locally, follow these steps:
+
+### Prerequisites
+- Python 3.7 or higher.
+- Git installed on your system.
+
+### Step-by-Step Guide
+
+1. **Clone the repository**:
+```bash
+git clone https://github.com/wenbinyugroup/swiftcomp-api.git
+cd swiftcomp-api
+```
+
+2. **Create and activate a virtual environment**:
+```bash
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+```
+
+3. **Install the dependencies**:
+```bash
+pip install -r requirements.txt
+```
+
+4. **Run the FastAPI application locally**:
+```bash
+uvicorn app.main:app --reload
+```
+
+This will start the SwiftComp API server at http://127.0.0.1:8000.
+
+## API Documentation
+FastAPI automatically generates interactive API documentation using **Swagger** and **Redoc**. Once the server is running, you can access the documentation at:
+
+* Swagger UI: http://127.0.0.1:8000/docs
+* ReDoc: http://127.0.0.1:8000/redoc
+
+## Sample Endpoints
+* **GET /**: Root endpoint, returns a welcome message.
+* **POST /api/v1/lamina_engineering_constants**: Calculates the lamina engineering constants based on the provided material properties.
+* **POST /api/v1/laminate_plate_properties**: Calculates the laminate plate properties.
+* **POST /api/v1/laminate_3d_properties**: Computes the 3D properties of laminate.
+* **POST /api/v1/udfrc_properties**: Calculates UDFRC properties.
+
+## Testing
+The repository includes unit tests using `pytest`. To run the tests:
+
+1. Ensure you are in the virtual environment.
+2. Run the following command:
+```bash
+PYTHONPATH=./ pytest
+```
+
+## Contributing
+We welcome contributions to **SwiftComp-API**! Here's how you can help:
+
+1. **Fork the repository**.
+2. **Create a new feature branch**:
+```bash
+git checkout -b feature/your-feature-name
+```
+3. **Commit your changes**:
+```bash
+git commit -m "Add your message"
+```
+4. **Push to the branch**:
+```bash
+git push origin feature/your-feature-name
+```
+5. **Create a pull request**: Describe the changes you’ve made.
+
+
+## License
+This project is licensed under the MIT License. See the LICENSE file for more details.

app/__init__.py

@@ -0,0 +1,17 @@
+from fastapi import FastAPI
+
+from app.routers.v1.lamina_engineering_constants import router as lamina_engineering_constants_router_v1
+from app.routers.v1.laminate_plate_properties import router as laminate_plate_properties_router_v1
+from app.routers.v1.laminate_3d_properties import router as laminate_3d_properties_router_v1
+from app.routers.v1.UDFRC_properties import router as udfrc_properties_router_v1
+
+app = FastAPI()
+
+@app.get("/")
+def read_root():
+    return {"message": "Hello SwiftComp API"}
+
+app.include_router(lamina_engineering_constants_router_v1, prefix="/api/v1")
+app.include_router(laminate_plate_properties_router_v1, prefix="/api/v1")
+app.include_router(laminate_3d_properties_router_v1, prefix="/api/v1")
+app.include_router(udfrc_properties_router_v1, prefix="/api/v1")

app/main.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel, Field
+
+# Request Model
+class Laminate3DPropertiesInput(BaseModel):
+    E1: float = Field(..., gt=0, description="Longitudinal modulus of the laminate (must be greater than 0).")
+    E2: float = Field(..., gt=0, description="Transverse modulus of the laminate (must be greater than 0).")
+    G12: float = Field(..., gt=0, description="In-plane shear modulus of the laminate (must be greater than 0).")
+    nu12: float = Field(..., ge=-1, le=0.5, description="Poisson's ratio in the laminate plane (must be between -1 and 0.5).")
+    nu23: float = Field(..., ge=-1, le=0.5, description="Poisson's ratio in the transverse plane (must be between -1 and 0.5).")
+    layup_sequence: str = Field(..., description="Layup sequence of the laminate (e.g., '[30/45]2s').")
+    layer_thickness: float = Field(..., gt=0, description="Thickness of each laminate layer (must be greater than 0).")

app/models/v1/laminate_3d_properties_input.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Field
+
+# Request Model
+class LaminatePlatePropertiesInput(BaseModel):
+    E1: float = Field(..., gt=0, description="Longitudinal modulus of the laminate (must be greater than 0).")
+    E2: float = Field(..., gt=0, description="Transverse modulus of the laminate (must be greater than 0).")
+    G12: float = Field(..., gt=0, description="In-plane shear modulus of the laminate (must be greater than 0).")
+    nu12: float = Field(..., ge=-1, le=0.5, description="Poisson's ratio in the laminate plane (must be between -1 and 0.5).")
+    layup_sequence: str = Field(..., description="Layup sequence of the laminate (e.g., '[30/45]2s').")
+    layer_thickness: float = Field(..., gt=0, description="Thickness of each laminate layer (must be greater than 0).")

app/models/v1/laminate_plate_properties_input.py

@@ -0,0 +1,20 @@
+from pydantic import BaseModel, Field
+from typing import List
+
+# Model for the engineering constants
+class EngineeringConstants(BaseModel):
+    E1: float
+    E2: float
+    E3: float
+    G12: float
+    G13: float
+    G23: float
+    nu12: float
+    nu13: float
+    nu23: float
+
+# Model for Voigt, Reuss, Hybrid rules of mixture
+class ThreeDimensionalPropertiesOutput(BaseModel):
+    Effective_3D_Stiffness_Matrix: List[List[float]] = Field(..., description="Effective 3D stiffness matrix (6x6).")
+    Effective_3D_Compliance_Matrix: List[List[float]] = Field(..., description="Effective 3D compliance matrix (6x6).")
+    Engineering_Constants: EngineeringConstants = Field(..., description="Engineering constants.")