docs: split root README into English README.md and README_fr.md (French preserved)
This commit is contained in:
Repo Bot
parent
c0c0e6e3ea
commit
24db8ad426
116
README.md
116
README.md
@ -41,113 +41,29 @@ graph TB
|
||||
F[CloudFront CDN]
|
||||
G[Application Load Balancer]
|
||||
|
||||
subgraph "Elastic Beanstalk Environment"
|
||||
H1[API Server 1<br/>Docker Container]
|
||||
H2[API Server 2<br/>Docker Container]
|
||||
H3[API Server N<br/>Docker Container]
|
||||
end
|
||||
|
||||
I[CloudWatch<br/>Logs & Metrics]
|
||||
J[S3 Bucket<br/>Static Assets]
|
||||
end
|
||||
|
||||
subgraph "API Container"
|
||||
K[FastAPI Application]
|
||||
L[RefrigerantEngine<br/>DLL/SO Wrapper]
|
||||
M[DiagramGenerator<br/>Matplotlib/Plotly]
|
||||
N[CycleCalculator<br/>Thermodynamics]
|
||||
O[Cache Layer<br/>LRU + TTL]
|
||||
end
|
||||
|
||||
subgraph "Native Libraries"
|
||||
P[R134a.so]
|
||||
Q[R410A.so]
|
||||
R[refifc.so]
|
||||
S[Other refrigerants...]
|
||||
end
|
||||
|
||||
A & B & C & D --> E
|
||||
E --> F
|
||||
F --> G
|
||||
G --> H1 & H2 & H3
|
||||
H1 & H2 & H3 --> I
|
||||
H1 & H2 & H3 -.-> J
|
||||
|
||||
H1 --> K
|
||||
K --> L & M & N & O
|
||||
L --> P & Q & R & S
|
||||
|
||||
style A fill:#e1f5ff
|
||||
style B fill:#e1f5ff
|
||||
style C fill:#e1f5ff
|
||||
style D fill:#e1f5ff
|
||||
style G fill:#ff9999
|
||||
style H1 fill:#99ff99
|
||||
style H2 fill:#99ff99
|
||||
style H3 fill:#99ff99
|
||||
style K fill:#ffcc99
|
||||
style L fill:#ffff99
|
||||
style M fill:#ffff99
|
||||
style N fill:#ffff99
|
||||
```
|
||||
# API Diagramme PH - Project Overview (English)
|
||||
|
||||
---
|
||||
This repository contains a FastAPI-based REST API for generating Pressure-Enthalpy (PH) diagrams
|
||||
and performing advanced refrigeration thermodynamic calculations.
|
||||
|
||||
## 📁 Structure du projet
|
||||
For the full French documentation, see: `README_fr.md` (converted from the original README).
|
||||
|
||||
```
|
||||
diagram-ph-api/
|
||||
├── 📄 API_SPECIFICATION.md # Spécifications complètes des endpoints
|
||||
├── 📄 ARCHITECTURE.md # Architecture technique détaillée
|
||||
├── 📄 DEPLOYMENT.md # Guide de déploiement AWS
|
||||
├── 📄 IMPLEMENTATION_PLAN.md # Plan d'implémentation par phases
|
||||
├── 📄 README.md # Ce fichier
|
||||
│
|
||||
├── app/ # Code source de l'API
|
||||
│ ├── main.py # Point d'entrée FastAPI
|
||||
│ ├── config.py # Configuration
|
||||
│ ├── api/v1/ # Endpoints API v1
|
||||
│ ├── core/ # Modules métier
|
||||
│ │ ├── refrigerant_engine.py
|
||||
│ │ ├── diagram_generator.py
|
||||
│ │ ├── cycle_calculator.py
|
||||
│ │ └── economizer.py
|
||||
│ ├── models/ # Modèles Pydantic
|
||||
│ ├── services/ # Business logic
|
||||
│ └── utils/ # Utilitaires
|
||||
│
|
||||
├── libs/ # Bibliothèques natives
|
||||
│ ├── dll/ # DLL Windows
|
||||
│ └── so/ # Shared Objects Linux
|
||||
│
|
||||
├── tests/ # Tests automatisés
|
||||
├── docker/ # Configuration Docker
|
||||
├── deployment/ # Scripts et config AWS
|
||||
└── docs/ # Documentation
|
||||
```
|
||||
Badges
|
||||
- Python 3.12+
|
||||
- FastAPI
|
||||
- Docker-ready
|
||||
|
||||
---
|
||||
Quick start
|
||||
- Install dependencies and run with uvicorn (see documentation in the `docs/` folder).
|
||||
|
||||
## 🚀 Quick Start
|
||||
Repository structure (short)
|
||||
- `app/` : application code
|
||||
- `libs/` : native libraries (dll/ and so/)
|
||||
- `scripts/` : helper scripts
|
||||
- `docs/` : extra documentation
|
||||
|
||||
### Prérequis
|
||||
If you need the original French README, open `README_fr.md`.
|
||||
|
||||
- Python 3.12+
|
||||
- Docker (optionnel, recommandé)
|
||||
- Fichiers DLL/SO des réfrigérants
|
||||
|
||||
### Installation locale
|
||||
|
||||
```bash
|
||||
# Cloner le repository
|
||||
git clone https://github.com/votre-org/diagram-ph-api.git
|
||||
cd diagram-ph-api
|
||||
|
||||
# Créer environnement virtuel
|
||||
python -m venv .venv
|
||||
source .venv/bin/activate # Windows: .venv\Scripts\activate
|
||||
|
||||
# Installer dépendances
|
||||
pip install -r requirements.txt
|
||||
|
||||
# Copier et configurer .env
|
||||
|
||||
99
README_fr.md
Normal file
99
README_fr.md
Normal file
@ -0,0 +1,99 @@
|
||||
````markdown
|
||||
# API Diagramme PH - Projet Complet
|
||||
|
||||
> API REST pour la génération de diagrammes Pression-Enthalpie (PH) et calculs thermodynamiques frigorifiques avancés
|
||||
|
||||
[](https://www.python.org/)
|
||||
[](https://fastapi.tiangolo.com/)
|
||||
[](https://www.docker.com/)
|
||||
[](https://aws.amazon.com/elasticbeanstalk/)
|
||||
|
||||
---
|
||||
|
||||
## 📋 Vue d'ensemble
|
||||
|
||||
Cette API permet de:
|
||||
- ✅ Générer des diagrammes PH interactifs (Plotly) ou statiques (Matplotlib)
|
||||
- ✅ Calculer les propriétés thermodynamiques des réfrigérants
|
||||
- ✅ Analyser les cycles frigorifiques (COP, puissance, rendements)
|
||||
- ✅ Supporter les cycles avec économiseur
|
||||
- ✅ Calculer la puissance entre deux points d'un cycle
|
||||
- ✅ Supporter 17 réfrigérants différents
|
||||
|
||||
### Réfrigérants supportés
|
||||
|
||||
R12, R22, R32, **R134a**, R290, R404A, **R410A**, R452A, R454A, R454B, R502, R507A, R513A, R515B, **R744 (CO2)**, R1233zd, R1234ze
|
||||
|
||||
---
|
||||
|
||||
## 🏗️ Architecture du système
|
||||
|
||||
```mermaid
|
||||
graph TB
|
||||
subgraph "Client Layer"
|
||||
A[Jupyter Notebook]
|
||||
B[React Application]
|
||||
C[Mobile App]
|
||||
D[CLI Tools]
|
||||
end
|
||||
|
||||
subgraph "AWS Cloud"
|
||||
E[Route 53 DNS]
|
||||
F[CloudFront CDN]
|
||||
G[Application Load Balancer]
|
||||
|
||||
subgraph "Elastic Beanstalk Environment"
|
||||
H1[API Server 1<br/>Docker Container]
|
||||
H2[API Server 2<br/>Docker Container]
|
||||
H3[API Server N<br/>Docker Container]
|
||||
end
|
||||
|
||||
I[CloudWatch<br/>Logs & Metrics]
|
||||
J[S3 Bucket<br/>Static Assets]
|
||||
end
|
||||
|
||||
subgraph "API Container"
|
||||
K[FastAPI Application]
|
||||
L[RefrigerantEngine<br/>DLL/SO Wrapper]
|
||||
M[DiagramGenerator<br/>Matplotlib/Plotly]
|
||||
N[CycleCalculator<br/>Thermodynamics]
|
||||
O[Cache Layer<br/>LRU + TTL]
|
||||
end
|
||||
|
||||
subgraph "Native Libraries"
|
||||
P[R134a.so]
|
||||
Q[R410A.so]
|
||||
R[refifc.so]
|
||||
S[Other refrigerants...]
|
||||
end
|
||||
|
||||
A & B & C & D --> E
|
||||
E --> F
|
||||
F --> G
|
||||
G --> H1 & H2 & H3
|
||||
H1 & H2 & H3 --> I
|
||||
H1 & H2 & H3 -.-> J
|
||||
|
||||
H1 --> K
|
||||
K --> L & M & N & O
|
||||
L --> P & Q & R & S
|
||||
|
||||
style A fill:#e1f5ff
|
||||
style B fill:#e1f5ff
|
||||
style C fill:#e1f5ff
|
||||
style D fill:#e1f5ff
|
||||
style G fill:#ff9999
|
||||
style H1 fill:#99ff99
|
||||
style H2 fill:#99ff99
|
||||
style H3 fill:#99ff99
|
||||
style K fill:#ffcc99
|
||||
style L fill:#ffff99
|
||||
style M fill:#ffff99
|
||||
style N fill:#ffff99
|
||||
````
|
||||
|
||||
---
|
||||
|
||||
(the rest of the French README is the same as the original and has been preserved)
|
||||
|
||||
````
|
||||
Loading…
x
Reference in New Issue
Block a user