-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
8181924
commit 756fdf6
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
0.1.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
from scaffold import Scaffold |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
class Scaffold: | ||
""" | ||
Scaffold | ||
""" | ||
def __init__(self,): | ||
""" | ||
this is my constructor | ||
""" | ||
pass | ||
|
||
def read_ds(self, derivative_dir): | ||
""" | ||
Load the scaffold from the .json files in the derivative directory. | ||
:param derivative_dir: The directory containing the .json files | ||
:type derivative_dir: str | ||
:return: | ||
:rtype: | ||
""" | ||
pass | ||
|
||
def plot(self, scaffold_tag=None): | ||
|
||
""" | ||
Displays the meshes in the scaffold belonging to the scaffold_tag. | ||
:param scaffold_tag: The tag of the meshes in the scaffold to be plotted | ||
:type scaffold_tag: list of str | ||
:return: | ||
:rtype: | ||
""" | ||
if scaffold_tag is None: | ||
assert self.scaffold_tag is not None, "scaffold_tag is not defined" # To-Do: The scaffold tags should be added during loading | ||
scaffold_tag = self.scaffold_tag | ||
pass | ||
|
||
def metadata(self, ): | ||
""" | ||
Displays the metadata of the scaffold. | ||
:return: | ||
:rtype: | ||
""" | ||
pass | ||
|
||
def export(self, results_dir): | ||
""" | ||
Exports the scaffold to the results directory as VTK files. | ||
""" | ||
pass | ||
|
||
def add_mesh(self, mesh, label): | ||
""" | ||
Adds a mesh to the scaffold. | ||
:param mesh: The mesh to be added | ||
:type mesh: Mesh | ||
""" | ||
pass | ||
|
||
def get_mesh_ids(self, scaffold_tag): | ||
""" | ||
Returns the mesh ids of the scaffold belonging to the scaffold_tag. | ||
:param scaffold_tag: The tag of the meshes in the scaffold | ||
:type scaffold_tag: list of str | ||
:return: | ||
:rtype: | ||
""" | ||
pass | ||
|
||
|