Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/Carlisle345748/Delft3D-Toolbox
/ functions
Functions
64 in github.com/Carlisle345748/Delft3D-Toolbox
⨍
Functions
64
◇
Types & classes
10
↓ 8 callers
Method
export
Export the data to a list in the format of Delft3D grd file. Examples ------- >>> import delft3d >>> grd = d
delft3d/GrdFile.py:267
↓ 4 callers
Method
export
Export the data to a list in the format of Delft3D time series file. Example ------- >>> import delft3d >>>
delft3d/TimeSeriesFile.py:113
↓ 4 callers
Method
set_header
Modify the content of the header. IMPORTANT: This method cannot change the value and the unit of a parameter simultaneously. If you w
delft3d/TimeSeriesFile.py:45
↓ 3 callers
Method
export
export the header in its original format
delft3d/TimeSeriesFile.py:311
↓ 3 callers
Method
set_parm
Set new value for a parameter. When setting new values for parameters with multiple values (single-line or multiple-line array parame
delft3d/MdfFile.py:62
↓ 2 callers
Method
add_parm
Add new parameter. When adding new values for parameters with multiple values (single-line or multiple-line array parameter e.g. Flma
delft3d/MdfFile.py:100
↓ 2 callers
Method
create_bat
Create bat file to call d_hydro.exe to execute simulation
delft3d/Simulation.py:214
↓ 2 callers
Method
create_xml
Create xml file for d_hydro.exe
delft3d/Simulation.py:197
↓ 2 callers
Method
grid_writer
Helper function of self.export. Formatting grid data as Delft3D grd file
delft3d/GrdFile.py:297
↓ 2 callers
Method
run
Run Delft3D simulations. Parallelization is supported by multiprocessing. Parameters ---------- mdf_file : list or t
delft3d/Simulation.py:93
↓ 2 callers
Method
set_header
Set new content of header. Called by TimeSeriesFile.set_header()
delft3d/TimeSeriesFile.py:217
↓ 2 callers
Method
sim_unit
Run one Delft3D simulation. This is the base method of self.run. Parameters ---------- mdf_file : str Th
delft3d/Simulation.py:152
↓ 2 callers
Method
spherical_to_cartesian
Convert from spherical coordinates to cartesian coordinates. Default spherical coordinate system: WGS 84. Default cartesian c
delft3d/GrdFile.py:52
↓ 2 callers
Method
to_file
Write the data to a Delft3D mdf file Parameters ---------- filename : str Filename of the mdf file
delft3d/MdfFile.py:194
↓ 1 callers
Method
cartesian_to_spherical
Convert from cartesian coordinates to spherical coordinates. Default spherical coordinate system: WGS 84. Default cartesian c
delft3d/GrdFile.py:86
↓ 1 callers
Method
export
Export the data to a ndarry in the format of Delft3D dep file. Examples ------- >>> import delft3d >>> dep =
delft3d/DepFile.py:131
↓ 1 callers
Method
export
Export the data to a list in the format of Delft3D mdf file Examples: --------- >>> import delft3d >>> mdf =
delft3d/MdfFile.py:137
↓ 1 callers
Method
export_header
Export the header as a list in the format of Delft3D time series file
delft3d/TimeSeriesFile.py:253
↓ 1 callers
Method
export_time_series
Export the time series as a list in the format of Delft3D time series files
delft3d/TimeSeriesFile.py:269
↓ 1 callers
Method
get_nearest_grid
Find the nearest grid for the giving coordinate. If the coordinate system is spherical, it will be automatically convert to cartesian
delft3d/GrdFile.py:120
↓ 1 callers
Method
load_dep
Read dep file
delft3d/DepFile.py:30
↓ 1 callers
Method
load_file
Read dep file
delft3d/GrdFile.py:24
↓ 1 callers
Method
load_file
Read bct/bcc/dis file. The content of the file will be stored in self.data.
delft3d/TimeSeriesFile.py:23
↓ 1 callers
Method
load_file
Read mdf file and store it in self.data as a dict
delft3d/MdfFile.py:19
↓ 1 callers
Method
load_header
Read and interpret the header of a time series.
delft3d/TimeSeriesFile.py:163
↓ 1 callers
Method
load_time_series
Read and interpret time series
delft3d/TimeSeriesFile.py:193
↓ 1 callers
Method
output_nc
Modify mdf file to save simulation as netcdf file
delft3d/Simulation.py:231
↓ 1 callers
Method
recursive_search
Recursively search for files or directories. Used by self.search_delft3d Parameters ---------- root : str or Path
delft3d/Simulation.py:63
↓ 1 callers
Method
search_delft3d
Search for the path of Delft3D source code. Parameters ---------- delft3d_path : str The path of the pre
delft3d/Simulation.py:28
↓ 1 callers
Method
set_time_series
Replace the old time series with the new one. Parameters ---------- num : int The no. of
delft3d/TimeSeriesFile.py:75
↓ 1 callers
Method
set_time_series
Replace the old time series with the new one. Called by TimeSeriesFile.set_time_series()
delft3d/TimeSeriesFile.py:233
Method
__call__
(self, x)
delft3d/Simulation.py:246
Method
__init__
(self, filename)
delft3d/GrdFile.py:18
Method
__init__
(self, filename, grd_file)
delft3d/DepFile.py:20
Method
__init__
(self, filename)
delft3d/TimeSeriesFile.py:18
Method
__init__
(self, time_series: list)
delft3d/TimeSeriesFile.py:157
Method
__init__
Read the store the format, type and unit of a header
delft3d/TimeSeriesFile.py:287
Method
__init__
(self, filename)
delft3d/MdfFile.py:15
Method
__init__
Delft3D simulation launcher Parameters ---------- delft3d_path : str The path of the pre-compiled Delft3
delft3d/Simulation.py:11
Method
__init__
(self, f, args)
delft3d/Simulation.py:242
Method
__repr__
(self)
delft3d/TimeSeriesFile.py:322
Method
export
Export all data as a list in the format of Delft3D time series files
delft3d/TimeSeriesFile.py:277
Method
plot
Visualize the grid.If the coordinate system is spherical, it will be automatically convert to cartesian coordinate system. You can sp
delft3d/GrdFile.py:168
Method
plot
Visualize the depth. If the coordinate system is spherical, it will be automatically convert to cartesian coordinate system. You can
delft3d/DepFile.py:45
Method
set_dep
set new dep data Parameters ---------- data : ndarray New dep data. Examples -------
delft3d/DepFile.py:115
Method
set_gird
Set new grid. Parameters ---------- x : ndarray x coordinates of the new grid y : ndarray
delft3d/GrdFile.py:241
Method
test_DepFile
(self)
test/test_Delft3DFiles.py:108
Method
test_GrdFile_coordinates
(self)
test/test_Delft3DFiles.py:88
Method
test_GrdFile_export
(self)
test/test_Delft3DFiles.py:78
Method
test_GrdFile_get_nearest_grid
(self)
test/test_Delft3DFiles.py:102
Method
test_MdfFile
(self)
test/test_Delft3DFiles.py:63
Method
test_bcc_export
(self)
test/test_Delft3DFiles.py:15
Method
test_bct_export
(self)
test/test_Delft3DFiles.py:9
Method
test_create_bat
(self)
test/testSimulation.py:35
Method
test_create_xml
(self)
test/testSimulation.py:24
Method
test_dis_export
(self)
test/test_Delft3DFiles.py:21
Method
test_run
(self)
test/testSimulation.py:52
Method
test_search_delft3d
(self)
test/testSimulation.py:8
Method
test_set_header
(self)
test/test_Delft3DFiles.py:27
Method
test_set_time_series
(self)
test/test_Delft3DFiles.py:43
Method
test_sim_unit
(self)
test/testSimulation.py:46
Method
to_file
Write the data to a Delft3D grd file. Parameters ---------- filename : str Filename of the grd file.
delft3d/GrdFile.py:322
Method
to_file
Write the data to a Delft3D dep file. Parameters ---------- filename : str Filename of Delft3D dep file
delft3d/DepFile.py:178
Method
to_file
Write the data to a Delft3D time series file. Parameters ---------- filename : str Filename of the time
delft3d/TimeSeriesFile.py:134