Spaces:
Build error
Build error
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,72 +1,9 @@
|
|
| 1 |
-
<h1 align="center">
|
| 2 |
-
<a href="https://github.com/GitsSaikat/Pavement-App">
|
| 3 |
-
<img src="Pavement.jpg" width="215" /></a><br>
|
| 4 |
-
<b>🛣️ Mechanistic-Empirical Pavement Design Tool</b><br>
|
| 5 |
-
</h1>
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
Welcome to the **Mechanistic-Empirical Pavement Design Tool for Highways and Airports**! This application is designed to assist engineers and researchers in designing and evaluating pavement structures based on traffic, material, and environmental data.
|
| 9 |
-
|
| 10 |
-
**The app is available at:** [https://pavement-design-app.streamlit.app/](https://pavement-design-app.streamlit.app/)
|
| 11 |
-
|
| 12 |
-
|
| 13 |
---
|
| 14 |
-
|
| 15 |
-
|
| 16 |
-
|
| 17 |
-
|
| 18 |
-
|
| 19 |
-
|
| 20 |
-
-
|
| 21 |
-
|
| 22 |
-
- **Report Generation**: Create and download detailed reports in PDF format.
|
| 23 |
-
|
| 24 |
-
---
|
| 25 |
-
|
| 26 |
-
## 🛠️ Installation
|
| 27 |
-
|
| 28 |
-
```bash
|
| 29 |
-
git clone https://github.com/GitsSaikat/Pavement-App.git
|
| 30 |
-
cd pavement-design-tool
|
| 31 |
-
pip install -r requirements.txt
|
| 32 |
-
streamlit run app.py
|
| 33 |
-
```
|
| 34 |
-
|
| 35 |
-
## Project Structure
|
| 36 |
-
|
| 37 |
-
|
| 38 |
-
- `app.py`: Main Streamlit application file.
|
| 39 |
-
- `Pavement.jpg`: Image used in the application.
|
| 40 |
-
- `src/`: Source code directory.
|
| 41 |
-
- `models.py`: Contains data model classes.
|
| 42 |
-
- `performance.py`: Includes functions for pavement performance simulation.
|
| 43 |
-
- `lcca.py`: Functions for life cycle cost analysis.
|
| 44 |
-
- `reporting.py`: Functions for report generation.
|
| 45 |
-
- `design.py`: Functions for designing the pavement structure.
|
| 46 |
-
- `utils/`: Contains utility scripts.
|
| 47 |
-
- `helpers.py`: Helper functions for file reading and saving.
|
| 48 |
-
- `logger.py`: Setting up logging.
|
| 49 |
-
- `README.md`: This file, contains project documentation
|
| 50 |
-
|
| 51 |
-
## Usage
|
| 52 |
-
|
| 53 |
-
**Input Data**: Either upload your data using an Excel file or manually enter all the required data to proceed with the design.
|
| 54 |
-
- **Excel File**: Make sure your Excel file contains sheets named 'Traffic', 'Climate', 'Subgrade' and 'Materials' with the correct columns. See instructions on the page.
|
| 55 |
-
- **Manual Entry**: Alternatively, fill the forms with the respective data fields, in which the comma separated values are supported in axle loads inputs.
|
| 56 |
-
|
| 57 |
-
**Design Pavement**: Define the pavement layers by entering the number of layers and then configure the type and thickness of each one.
|
| 58 |
-
|
| 59 |
-
**Run Simulation**: Set initial costs, maintenance costs, discount rate, and analysis period to run the pavement simulation and LCCA.
|
| 60 |
-
|
| 61 |
-
**View Results**: Analyze the simulation results, lifecycle cost, and pavement design details through tables and charts.
|
| 62 |
-
|
| 63 |
-
**Generate Report**: Create a comprehensive PDF report of your analysis.
|
| 64 |
-
|
| 65 |
-
## Contributing
|
| 66 |
-
|
| 67 |
-
Contributions are welcome! If you find a bug or have suggestions for new features, please open an issue or submit a pull request.
|
| 68 |
-
|
| 69 |
-
## License
|
| 70 |
-
|
| 71 |
-
This project is licensed under the [MIT License](LICENSE).
|
| 72 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
license: mit
|
| 3 |
+
title: Pavement Design
|
| 4 |
+
sdk: streamlit
|
| 5 |
+
emoji: 🔥
|
| 6 |
+
colorFrom: indigo
|
| 7 |
+
colorTo: blue
|
| 8 |
+
short_description: 'Mechanistic-Empirical Pavement Design Tool for Highways and '
|
| 9 |
+
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|