Skip to content

Commit 8766abb

Browse files
authored
Update README.md
1 parent 1f7d74c commit 8766abb

1 file changed

Lines changed: 70 additions & 67 deletions

File tree

README.md

Lines changed: 70 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,80 +1,83 @@
11
# Project Title
22

3-
This repository contains a collection of Python scripts for automating the extraction and processing of geotechnical data from PLAXIS models. The scripts are designed to streamline the workflow for analyzing cross-section results, strut forces, wall forces, settlements, and more. They provide functionalities for batch processing of multiple models and generating comprehensive reports.
3+
This repository contains a collection of Python scripts for automating the extraction and processing of geotechnical data from PLAXIS models. The scripts are designed to streamline the workflow for analyzing cross-section results, strut forces, wall forces, settlements, and more. They provide functionalities for batch processing of multiple models.
44

55
## Table of Contents
66

77
- [Installation](#installation)
8-
- [Usage](#usage)
9-
- [SectionVaryAlongXY](#sectionvaryalongxy)
10-
- [Section_StageByStage](#section_stagebystage)
11-
- [BatchExtractSettlement_Simple](#batchextractsettlement_simple)
12-
- [BatchExtractStrutForce_Simple](#batchextractstrutforce_simple)
13-
- [BatchExtractWallForce_Simple](#batchextractwallforce_simple)
14-
- [BatchCalculate](#batchcalculate)
15-
- [Rearrange_pdf](#rearrange_pdf)
16-
- [RunThis](#runthis)
17-
- [RunSingle](#runsingle)
18-
- [RunAllInFolder](#runallinfolder)
8+
- [Functions](#functions)
9+
- [Core Functions](#core-functions)
10+
- [Section Analysis](#section-analysis)
11+
- [Batch Processing](#batch-processing)
12+
- [Miscellaneous](#miscellaneous)
1913
- [Author](#author)
2014

2115
## Installation
2216

23-
To use the scripts in this repository, you need to have Python installed on your machine along with the following packages:
24-
25-
- `plxscripting`
26-
- `PyPDF2`
27-
- `datetime`
28-
- `os`
29-
- `re`
30-
- `typing`
31-
32-
You can install the required packages using pip:
33-
34-
`pip install plxscripting PyPDF2`
35-
36-
## Usage
37-
38-
### SectionVaryAlongXY
39-
40-
This function prompts the user to input parameters for varying a cross-section cut along the x or y direction. It then extracts and prints the minimum and maximum normal stresses for specified phases.
41-
42-
### Section_StageByStage
43-
44-
This function extracts and prints the minimum and maximum normal total stresses for each phase along a specified cross-section.
45-
46-
### BatchExtractSettlement_Simple
47-
48-
This function allows batch processing of multiple PLAXIS models to extract settlement data along a specified y-level.
49-
50-
### BatchExtractStrutForce_Simple
51-
52-
This function extracts strut forces from multiple PLAXIS models and prints the results for each phase.
53-
54-
### BatchExtractWallForce_Simple
55-
56-
This function extracts wall forces for each phase and prints the maximum and minimum values for each force component.
57-
58-
### BatchCalculate
59-
60-
This function automates the calculation process for a batch of PLAXIS models, saving each model after calculation.
61-
62-
### Rearrange_pdf
63-
64-
This function rearranges pages of a PDF file based on the order specified in a text file.
65-
66-
### RunThis
67-
68-
This function automates the extraction of both strut and wall forces, and optionally generates a plot image.
69-
70-
### RunSingle
71-
72-
This function processes a single PLAXIS file, extracting forces and optionally generating a plot image.
73-
74-
### RunAllInFolder
75-
76-
This function processes all PLAXIS files in a specified folder, extracting forces and optionally generating plot images.
17+
To use the scripts in this repository, you need to have Plaxis 2D installed on your machine.
18+
19+
Open the Python interpreter in Plaxis Input or Output (depending on input automation or result extraction automation) to start using the scripts:
20+
21+
![image](https://github.com/user-attachments/assets/b3b2b69c-eba6-453a-9111-a2df80e3034a)
22+
23+
## Functions
24+
25+
### Core Functions
26+
27+
- **StrutForceAutomation**
28+
29+
- Extracts strut forces within a specified range of x-coordinates from the PLAXIS model.
30+
- **WallForceAutomation**
31+
32+
- Retrieves and processes wall forces, merging data where applicable.
33+
- **PlotImage**
34+
35+
- Exports an image of the current PLAXIS model, focusing on displacement results.
36+
- **SettlementAutomation**
37+
38+
- Extracts settlement data at specified levels and x-coordinates.
39+
40+
### Batch Processing
41+
42+
- **BatchExtractSettlement_Simple**
43+
44+
- Processes multiple PLAXIS models to extract settlement data along a specified y-level.
45+
- **BatchExtractStrutForce_Simple**
46+
47+
- Extracts strut forces from multiple PLAXIS models and prints the results for each phase.
48+
- **BatchExtractWallForce_Simple**
49+
50+
- Extracts wall forces for each phase and prints the maximum and minimum values for each force component.
51+
- **BatchCalculate**
52+
53+
- Automates the calculation process for a batch of PLAXIS models, saving each model after calculation.
54+
- Users can input multiple file paths separated by commas, and the script will process each model in sequence. Calculation times for individual models and the total processing time are displayed.
55+
56+
### Section Analysis
57+
58+
- **SectionVaryAlongXY**
59+
60+
- Prompts the user to input parameters for varying a cross-section along the x or y direction.
61+
- Extracts and prints the minimum and maximum normal stresses for specified phases.
62+
- **Section_StageByStage**
63+
64+
- Extracts and prints minimum and maximum total normal stresses for each phase along a specified cross-section.
65+
66+
### Miscellaneous
67+
68+
- **Rearrange_pdf**
69+
70+
- Rearranges pages of a PDF file based on the order specified in a text file.
71+
- **RunThis**
72+
73+
- Automates the extraction of both strut and wall forces, and optionally generates a plot image.
74+
- **RunSingle**
75+
76+
- Processes a single PLAXIS file, extracting forces and optionally generating a plot image.
77+
- **RunAllInFolder**
78+
79+
- Processes all PLAXIS files in a specified folder, extracting forces and optionally generating plot images.
7780

7881
## Author
7982

80-
This project was created by Kinen Ma. The initial version was made on 2023-05-23, and the latest updates were made on 2024-04-12.
83+
This project was created by Kinen Ma.

0 commit comments

Comments
 (0)