diff --git a/src/sparc_imp/VERSION b/src/sparc_imp/VERSION new file mode 100644 index 0000000..6e8bf73 --- /dev/null +++ b/src/sparc_imp/VERSION @@ -0,0 +1 @@ +0.1.0 diff --git a/src/sparc_imp/__init__.py b/src/sparc_imp/__init__.py new file mode 100644 index 0000000..d666d7c --- /dev/null +++ b/src/sparc_imp/__init__.py @@ -0,0 +1 @@ +from scaffold import Scaffold \ No newline at end of file diff --git a/src/sparc_imp/scaffold.py b/src/sparc_imp/scaffold.py new file mode 100644 index 0000000..d7c3c4e --- /dev/null +++ b/src/sparc_imp/scaffold.py @@ -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 + + \ No newline at end of file