### ===================================================================================================================
### START TOOL - Files
### ===================================================================================================================
# Copyright ©VIIA 2025
### ===================================================================================================================
### 1. Import modules
### ===================================================================================================================
# General imports
from pathlib import Path
from datetime import date
from typing import Optional
from warnings import warn
from viiapackage import __version__
### ===================================================================================================================
### 2. Create the user_config file in workfolder
### ===================================================================================================================
[docs]def viia_create_user_config(folder: Path, email: str, password: str) -> str:
"""
This function creates the user-config file that is used for the connection to the MYVIIA database.
.. note:: Credentials should be stored in the user-config file. Do not save credentials in scripts.
Input:
- folder (Path): Location where to save the file.
- email (str): Username in MYVIIA tool, VIIA email. Optional input, if None provided the credentials in the
user-config file will be used.
- password (str): Password for MYVIIA tool. Optional input, if None provided the credentials in the user-config
file will be used.
Output:
- A message is returned if action was successful.
"""
# Create the text to be written
text = \
f"connection_dict = {{\n 'myviia': {{\n 'email': '{email}',\n 'password': '{password}'}}}}\n"
# Create file
file = folder / 'user_config.py'
# Check if it exists
if file.exists():
return 'WARNING: User-config file already exists, no new file created.'
# Write data to file
file.write_text(str(text))
return 'File created'
### ===================================================================================================================
### 3. Copy and update modelscript template
### ===================================================================================================================
[docs]def viia_copy_and_update_model_script_template(
folder: Path, object_nr: str, initials: str, object_part: str = None) -> Optional[Path]:
"""
This function copies the model script template to the workfolder and prepares it for use, by filling it with known
information.
Input:
- folder (Path): Location where to save the file, the workfolder.
- object_nr (str): VIIA object number.
- initials (str): Initials of the structural engineer.
- object_part (str): Name of the object-part (use name of the object-part in MYVIIA). In case of no object-parts
input should be None, which is the default value. This links to the 'Gehele object' in MYVIIA.
Output:
- Returns the file path when it is created properly.
"""
# Get the template of the modelscript
model_script_template = Path(__file__).parent.parent.parent / 'templates/template_modelscript.py'
# Check if it exists
if not model_script_template.exists():
raise FileNotFoundError(
f"ERROR: Could not find the main script template file at: {model_script_template.as_posix()}. Please "
f"check.")
# Read the template
text = model_script_template.read_text()
# Update data in the modelscript
text = text.replace(
"Objectnr: XXXX",
f"Objectnr: {object_nr}")
text = text.replace(
"Structural engineer: Name",
f"Structural engineer: {initials}")
text = text.replace(
"# TEMPLATE ",
f'# File created {date.today().strftime("%d-%m-%Y")} based on TEMPLATE ')
text = text.replace(
f"# viiapackage version v##.#.#",
f"# viiapackage version v{__version__}")
if object_part:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', object_part='{object_part}', version_nr=1)")
else:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', version_nr=1)")
text = text.replace(
"project.viia_write_dump(project.name + '.json', project.workfolder_location)",
f"project.viia_write_dump(filename={object_nr}-model.json', folder='model')")
# New location of file
to_file = folder / f'VIIA_{object_nr}_modelscript.py'
# Create a copy of the file in the selected folder
to_file.write_text(text)
if to_file.exists():
return to_file
return None
### ===================================================================================================================
### 4. Copy and update main script template
### ===================================================================================================================
[docs]def viia_copy_and_update_main_script_template(
folder: Path, object_nr: str, initials: str, analysis_type: str = 'NLTH', object_part: str = None,
foundation_type: str = 'shallow') -> Optional[Path]:
"""
This function copies the main script template to the workfolder and prepares it for use, by filling it with known
information.
Input:
- folder (Path): Location where to save the file, the workfolder.
- object_nr (str): VIIA object number.
- initials (str): Initials of the structural engineer.
- object_part (str): Name of the object-part (use name of the object-part in MYVIIA). In case of no object-parts
input should be None, which is the default value. This links to the 'Gehele object' in MYVIIA.
- foundation_type (str): Type of foundation, select from 'shallow', 'piles' or 'mixed'. This information is used
to prepare the mainscript for the specific situation.
Output:
- Returns the file path when it is created properly.
"""
# Get the template of the modelscript
if analysis_type.upper() == 'NLPO':
main_script_template = Path(__file__).parent.parent.parent / 'templates/template_mainscript_NLPO.py'
else:
main_script_template = Path(__file__).parent.parent.parent / 'templates/template_mainscript_NLTH.py'
# Check if it exists
if not main_script_template.exists():
raise FileNotFoundError(
f"ERROR: Could not find the main script template file at: {main_script_template.as_posix()}. Please check.")
# Read the template
text = main_script_template.read_text()
# Update data in the modelscript
text = text.replace(
"Objectnr: XXXX",
f"Objectnr: {object_nr}")
text = text.replace(
"Structural engineer: Name",
f"Structural engineer: {initials}")
text = text.replace(
"# TEMPLATE ",
f'# File created {date.today().strftime("%d-%m-%Y")} based on TEMPLATE ')
text = text.replace(
f"# viiapackage version v##.#.#",
f"# viiapackage version v{__version__}")
if foundation_type == 'shallow':
text = text.replace(
"""# Apply pile foundation fixed base
# Set the coordinates of the piles
# Input as floats for x- and y-coordinate of the piles, dimensions in [m]
pile_coordinates = [
[1.00000E+00, 9.54000E+00],
[3.50000E+00, 9.54000E+00],
[6.00000E+00, 9.54000E+00]]
if any(a in ['A1', 'A2', 'A3', 'A4'] for a in analysis):
# Create piles, make sure to add the pile-group in MYVIIA first
project.viia_create_piles(coordinates=pile_coordinates, pile_group='A')
""", '')
text = text.replace(
""" # Apply pile foundation flexbase
# If there is pile foundation (use pile tool for sending data to MYVIIA first before creating flexbase piles)
project.viia_create_piles(coordinates=pile_coordinates, support_type='FlexBaseGlobal', pile_group='A')
""", '')
if foundation_type == 'piles':
text = text.replace(
"""# Apply shallow foundation fixed base
# You can specify additional and to be excluded surfaces
if any(a in ['A1', 'A2', 'A3', 'A4'] for a in analysis):
project.viia_create_supports()
""", '')
text = text.replace(
""" # Apply shallow foundation flexbase
# Select for FexBaseGlobal or FlexBaseFinal. Only select FlexBaseFinal if geotechnical advisor has provided input
# on MYVIIA for the shallow foundations, else the values are calculated based on average values for FlexBaseGlobal
project.viia_create_supports(support_type='FlexBaseGlobal')
""", '')
if object_part:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', object_part='{object_part}', version_nr=1)")
else:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', version_nr=1)")
text = text.replace(
"project.viia_read_dump('model/XXXX-model', False)",
f"project.viia_read_dump('model/{object_nr}-model', False)")
# New location of file
to_file = folder / f'VIIA_{object_nr}_mainscript.py'
# Create a copy of the file in the selected folder
to_file.write_text(text)
if to_file.exists():
return to_file
return None
### ===================================================================================================================
### 5. Copy and update result script template
### ===================================================================================================================
[docs]def viia_copy_and_update_result_script_template(
folder: Path, object_nr: str, initials: str, analysis_type: str = 'NLTH', object_part: str = None,
abaqus: bool = False) -> Optional[Path]:
"""
This function copies the result script template to the workfolder and prepares it for use, by filling it with the
known information.
Input:
- folder (Path): Location where to save the file, the workfolder.
- object_nr (str): VIIA object number.
- initials (str): Initials of the structural engineer.
- object_part (str): Name of the object-part (use name of the object-part in MYVIIA). In case of no object-parts
input should be None, which is the default value. This links to the 'Gehele object' in MYVIIA.
- abaqus (bool): Select if the result script for ABAQUS software is required.
Output:
- Returns the file path when it is created properly.
"""
# Get the template of the modelscript
if analysis_type.upper() == 'NLPO':
result_script_template = Path(__file__).parent.parent.parent / 'templates/template_resultscript_NLPO.py'
elif abaqus:
result_script_template = Path(__file__).parent.parent.parent / 'templates/template_resultscript_NLTH_abaqus.py'
else:
result_script_template = Path(__file__).parent.parent.parent / 'templates/template_resultscript_NLTH.py'
# Check if it exists
if not result_script_template.exists():
raise FileNotFoundError(
f"ERROR: Could not find the result script template file at: {result_script_template.as_posix()}. Please "
f"check.")
# Read the template
text = result_script_template.read_text()
# Update data in the modelscript
text = text.replace(
"Objectnr: XXXX",
f"Objectnr: {object_nr}")
text = text.replace(
"Structural engineer: Name",
f"Structural engineer: {initials}")
text = text.replace(
"# TEMPLATE ",
f'# File created {date.today().strftime("%d-%m-%Y")} based on TEMPLATE ')
text = text.replace(
f"# viiapackage version v##.#.#",
f"# viiapackage version v{__version__}")
if object_part:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', object_part='{object_part}', version_nr=1)")
else:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', version_nr=1)")
# New location of file
to_file = folder / f'VIIA_{object_nr}_resultscript.py'
# Create a copy of the file in the selected folder
to_file.write_text(text)
if to_file.exists():
return to_file
return None
### ===================================================================================================================
### 6. Copy and update report script template
### ===================================================================================================================
[docs]def viia_copy_and_update_report_script_template(
folder: Path, object_nr: str, initials: str, analysis_type: str = 'NLTH', object_part: str = None) \
-> Optional[Path]:
"""
This function copies the report script template to the working folder and prepares it for use, by filling it with
known information.
Input:
- folder (Path): Location where to save the file, the workfolder.
- object_nr (str): VIIA object number.
- initials (str): Initials of the structural engineer.
- object_part (str): Name of the object-part (use name of the object-part in MYVIIA). In case of no object-parts
input should be None, which is the default value. This links to the 'Gehele object' in MYVIIA.
Output:
- Returns the file path when it is created properly.
"""
# Get the template of the modelscript
if analysis_type.upper() == 'NLTH':
report_script_template = Path(__file__).parent.parent.parent / 'templates/template_reportscript_NLTH.py'
else:
return None
# Check if it exists
if not report_script_template.exists():
raise FileNotFoundError(
f"ERROR: Could not find the report script template file at: {report_script_template.as_posix()}. Please "
f"check.")
# Read the template
text = report_script_template.read_text()
# Update data in the report script
text = text.replace(
"Objectnr: XXXX",
f"Objectnr: {object_nr}")
text = text.replace(
"Structural engineer: Name",
f"Structural engineer: {initials}")
text = text.replace(
"# TEMPLATE ",
f'# File created {date.today().strftime("%d-%m-%Y")} based on TEMPLATE ')
text = text.replace(
f"# viiapackage version v##.#.#",
f"# viiapackage version v{__version__}")
if object_part:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', object_part='{object_part}', version_nr=1)")
else:
text = text.replace(
"project = viia_create_project(project_name='XXXX', version_nr=1)",
f"project = viia_create_project(project_name='{object_nr}', version_nr=1)")
# New location of file
to_file = folder / f'VIIA_{object_nr}_reportscript.py'
# Create a copy of the file in the selected folder
to_file.write_text(text)
if to_file.exists():
return to_file
return None
### ===================================================================================================================
### 7. Copy and update template dashboard script template
### ===================================================================================================================
### ===================================================================================================================
### 8. Create box shortcut in workfolder
### ===================================================================================================================
[docs]def viia_create_box_shortcut(object_nr: str, box_folder_link: Path, folder: Path = None):
"""
Creates a shortcut to the box folder of the object.
Input:
- object_nr (str): VIIA object number as a string.
- box_folder_link (obj): Box folder as a path object.
- folder (obj): Folder where the shortcut should be placed as path.
Output:
- Returns file object of the shortcut.
"""
if not folder:
folder = Path.cwd()
file = open(folder / f'boxfolder_{object_nr}.url', 'w')
file.write(f"[InternetShortcut]\nURL={box_folder_link}")
file.close()
return file
### ===================================================================================================================
### 9. Create protocol shortcut in workfolder
### ===================================================================================================================
[docs]def viia_create_protocol_shortcut(folder: Path = None):
"""
Creates a shortcut to the online protocol in the provided (work)folder.
Input:
- folder (obj): Folder where the shortcut should be placed.
Output:
- Returns the file object of the shortcut.
"""
if not folder:
folder = Path.cwd()
file = open(folder / f'protocol.url', 'w')
file.write(f"[InternetShortcut]\nURL=https://viiapackage.azurewebsites.net/")
file.close()
return file
### ===================================================================================================================
### 10. Create BoD shortcut in workfolder
### ===================================================================================================================
[docs]def viia_create_bod_shortcut(bod_version: str, bod_folder_link: str, folder: Path = None):
"""
Creates a shortcut to the required Basis of Design document (UPR document).
Input:
- bod_version (str): Version of the Basis of Design as a string.
- bod_folder_link (obj): Basis of Design folder link as a string.
- folder (obj): Folder where the shortcut should be placed.
Output:
- Returns the file object of the shortcut.
"""
if not folder:
folder = Path.cwd()
file = open(folder / f"{bod_version.replace(' ', '_')}.url", 'w')
file.write(f"[InternetShortcut]\nBoD={bod_folder_link}")
file.close()
return file
### ===================================================================================================================
### 11. Download cheat sheet in workfolder
### ===================================================================================================================
[docs]def viia_download_cheat_sheet(folder: Path = None):
"""
Download cheat sheet from the protocol in the provided (work)folder.
Input:
- folder (obj): Folder where the cheat sheet should be placed.
Output:
- Returns the file object of the cheat sheet.
"""
import requests
if not folder:
folder = Path.cwd()
file_path = folder / 'Cheat_Sheet_Viiapackage.pdf'
# Download the cheat from the protocol
cheat_sheet_link = \
"https://viiapackage.azurewebsites.net/_downloads/8494fd89dd0954beba74bb64ffc220f4/Cheat_Sheet_Viiapackage.pdf"
query_parameters = {"downloadformat": "pdf"}
response = requests.get(cheat_sheet_link, params=query_parameters)
# Create a new file in the folder
with open(file_path, mode="wb") as file:
file.write(response.content)
# Check if it exists
if not file_path.exists():
warn(
'WARNING: Could not retrieve the cheat sheet file. You can download the cheat sheet from the protocol '
'(https://viiapackage.azurewebsites.net/doc_02_starting_phase.html#draft-model).')
return file_path
### ===================================================================================================================
### 12. End of script
### ===================================================================================================================