toughanimator 0.1.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: toughanimator
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: A tool for visualizing TOUGH simulation outputs.
|
|
5
|
+
Home-page: https://github.com/scarletref/toughanimator
|
|
6
|
+
Author: Your Name
|
|
7
|
+
Author-email: your.email@example.com
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
10
|
+
Classifier: Operating System :: OS Independent
|
|
11
|
+
Requires-Python: >=3.7
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
Requires-Dist: numpy
|
|
14
|
+
Requires-Dist: pandas
|
|
15
|
+
Requires-Dist: vtk
|
|
16
|
+
Dynamic: author
|
|
17
|
+
Dynamic: author-email
|
|
18
|
+
Dynamic: classifier
|
|
19
|
+
Dynamic: description
|
|
20
|
+
Dynamic: description-content-type
|
|
21
|
+
Dynamic: home-page
|
|
22
|
+
Dynamic: requires-dist
|
|
23
|
+
Dynamic: requires-python
|
|
24
|
+
Dynamic: summary
|
|
25
|
+
|
|
26
|
+
# ToughAnimator
|
|
27
|
+
|
|
28
|
+
## Installation
|
|
29
|
+
|
|
30
|
+
1. **Clone the Repository**:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
git clone https://stride-c.synology.me:50000/ytkuof/toughanimator.git
|
|
34
|
+
cd toughanimator
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
2. **Create a Python Virtual Environment**:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
python -m venv .env
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
3. **Activate the Virtual Environment**:
|
|
44
|
+
|
|
45
|
+
- **Windows**:
|
|
46
|
+
```bash
|
|
47
|
+
.env\Scripts\activate.bat
|
|
48
|
+
```
|
|
49
|
+
- **Linux/Mac**:
|
|
50
|
+
```bash
|
|
51
|
+
source .env/bin/activate
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
4. **Install Dependencies**:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
pip install -r requirements.txt
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
5. **Install ToughAnimator Locally**:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
pip install .
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
This will install ToughAnimator in your Python virtual environment.
|
|
67
|
+
|
|
68
|
+
## Run Your Own Case with ToughAnimator
|
|
69
|
+
|
|
70
|
+
1. **Create a New Case**:
|
|
71
|
+
|
|
72
|
+
- Create a new folder under `unresolve`. Name the folder according to your case (e.g., `unresolve/your_case_name`).
|
|
73
|
+
- Copy all necessary TOUGH result files into the new folder.
|
|
74
|
+
- Copy the `config.json` file from an existing case in the `test_cases` directory or create a new `config.json` file in the new folder. The file should have the following structure:
|
|
75
|
+
|
|
76
|
+
```json
|
|
77
|
+
{
|
|
78
|
+
"case_name": "your_case_name",
|
|
79
|
+
"input_files": [
|
|
80
|
+
"name_of_your_input_file (e.g., flow.inp)",
|
|
81
|
+
"MESH", // For a separate mesh file, if applicable
|
|
82
|
+
"INCON" // For a separate INCON file, if applicable
|
|
83
|
+
],
|
|
84
|
+
"output_files": [
|
|
85
|
+
"name_of_your_output_file (e.g., conn.csv)",
|
|
86
|
+
"name_of_another_output_file (e.g., mesh.csv)",
|
|
87
|
+
"name_of_other_output_file (add or remove as needed)"
|
|
88
|
+
],
|
|
89
|
+
"corners_file": "name_of_your_corners_file (e.g., corners.csv)",
|
|
90
|
+
"nas_path": "path/to/nas",
|
|
91
|
+
"notes": "Any additional notes"
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
- The `config.json` file should contain these fields:
|
|
96
|
+
- **case_name**: The name of your case.
|
|
97
|
+
- **input_files**: A list of TOUGH input files (e.g., `flow.inp`). You can include multiple input files, but they must contain the `INCON`, `ELEME`, and `CONNE` blocks.
|
|
98
|
+
- **output_files**: A list of output files (e.g., `conn.csv`, `mesh.csv`). Only CSV format files are currently supported.
|
|
99
|
+
- **corners_file**: The name of the corners file (e.g., `corners.csv`). This field is optional and can be omitted if not applicable.
|
|
100
|
+
- To obtain the corners file, open the **3D Results** in your PetraSim project, select **Export Data** from the **File** menu, and on the right side of the file-saving window, set the **Interpolation type** to **Interpolate to cell corners**. Save the file as CSV.
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
- **nas_path**: The path to the NAS (Network Attached Storage) location where the case files are stored. This field is optional.
|
|
105
|
+
- **notes**: Any additional notes or comments about the case. This field is optional.
|
|
106
|
+
|
|
107
|
+
2. **Run the Script**:
|
|
108
|
+
|
|
109
|
+
- Ensure the virtual environment is activated.
|
|
110
|
+
- Open `toughanimator/run.py` in VS Code and select **Run Without Debugging** (Ctrl+F5) or run the script from the command line:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
python run.py
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Run an Existing Case with ToughAnimator
|
|
117
|
+
|
|
118
|
+
1. **Set Name and Directory**:
|
|
119
|
+
|
|
120
|
+
- Open `toughanimator/run.py`.
|
|
121
|
+
- Modify the `dir_name` and `case_name` variables to match your case directory and name.
|
|
122
|
+
|
|
123
|
+
2. **Run the Script**:
|
|
124
|
+
|
|
125
|
+
- Ensure the virtual environment is activated.
|
|
126
|
+
- Open `toughanimator/run.py` in VS Code and select **Run Without Debugging** (Ctrl+F5) or run the script from the command line:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
python run.py
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## Acknowledgments
|
|
133
|
+
|
|
134
|
+
Special thanks to the TOUGH3 development team for their outstanding work on the TOUGH suite of tools.
|
|
135
|
+
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
toughanimator/__init__.py,sha256=m1f3fJ1SNGLNKxHlS0pLNHwaHlN6UUTh5GpS_8hC8kw,30
|
|
2
|
+
toughanimator/run.py,sha256=bMKe57yNZuKhekCkWMHawENKYdO5yRLpEzjGwaD-wWw,650
|
|
3
|
+
toughanimator/tough_classes.py,sha256=dwoWT__RKagI99k9qgrIFjA5pDNQQeL6fTIpo0HTBxQ,103880
|
|
4
|
+
toughanimator-0.1.2.dist-info/METADATA,sha256=dZ45QegPf26VpdhACaA1MaUUiClwe-I5DfKKd8gb-Hg,4557
|
|
5
|
+
toughanimator-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
|
|
6
|
+
toughanimator-0.1.2.dist-info/top_level.txt,sha256=pAT-UflvbjT4lTmBdzHqApZGWbywkSM3Y_qsHyLi4pU,14
|
|
7
|
+
toughanimator-0.1.2.dist-info/RECORD,,
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
toughanimator
|