move test folder to main folder and create doc folder

mbonatte · Aug 28, 2023 · 475a004 · 475a004
1 parent 19f1bb9
commit 475a004
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 6 deletions.
diff --git a/doc/README.md b/doc/README.md
@@ -0,0 +1,21 @@
+CONTENTS:
+
+[1]   What is here
+
+
+
+
+[1] What is here
+==============================================================================
+The directory tree below holds documentation of the SeCan package.  
+
+SECAN_DOC_DIR
+|
+|-- user_manual        - secan user manual
+|
+|-- material_manual    - material library documentation. Description of available material 
+|                        models and their parameters 
+|
+|-- theory_manual      - theory manual
+|
+|-- programmer_manual  - secan programmer's manual 
diff --git a/secan/material.py b/secan/material.py
@@ -19,7 +19,7 @@ class Material(ABC):
     @abstractmethod
     def get_stiff(self, strain: float) -> float:
         """
-        Calculate material stiffness based on the given strain.
+        Calculate material tangent stiffness based for a given strain.
 
         Args:
             strain (float): Strain value.
@@ -32,7 +32,7 @@ def get_stiff(self, strain: float) -> float:
     @abstractmethod
     def get_stress(self, strain: float) -> float:
         """
-        Calculate material stress based on the given strain.
+        Calculate material stress for a given strain.
 
         Args:
             strain (float): Strain value.
@@ -44,7 +44,7 @@ def get_stress(self, strain: float) -> float:
 
     def plot(self, plot=None):
         """
-        Plot the material (default implementation prints a message).
+        Plot the material stress/strain relationship (default implementation prints a message).
 
         Args:
             plot (object): Plotting object (optional).

diff --git a/secan/test/__init__.py → test/__init__.py b/secan/test/__init__.py → test/__init__.py
diff --git a/secan/test/test.py → test/test.py b/secan/test/test.py → test/test.py
@@ -1,8 +1,8 @@
 import unittest
 import numpy as np
-from ..section import Section
-from ..material import Concrete, SteelIdeal, SteelHardening
-from ..geometry import RectSection, Rebar, Tendon
+from secan.section import Section
+from secan.material import Concrete, SteelIdeal, SteelHardening
+from secan.geometry import RectSection, Rebar, Tendon
 
 class TestMaterials(unittest.TestCase):