diff --git a/pydrex/cli.html b/pydrex/cli.html index daee4ebc..49d8c3d3 100644 --- a/pydrex/cli.html +++ b/pydrex/cli.html @@ -50,6 +50,24 @@

API Documentation

@@ -138,8 +162,8 @@

7 """Base class for exceptions in PyDRex.""" 8 9 -10class ConfigError(Error): -11 """Exception raised for errors in the input configuration. +10class MissingDependencyError(Error): +11 """Exception raised when optional dependencies are missing. 12 13 Attributes: 14 message — explanation of the error @@ -150,8 +174,8 @@

19 self.message = message 20 21 -22class MeshError(Error): -23 """Exception raised for errors in the input mesh. +22class ConfigError(Error): +23 """Exception raised for errors in the input configuration. 24 25 Attributes: 26 message — explanation of the error @@ -162,8 +186,8 @@

31 self.message = message 32 33 -34class IterationError(Error): -35 """Exception raised for errors in numerical iteration schemes. +34class MeshError(Error): +35 """Exception raised for errors in the input mesh. 36 37 Attributes: 38 message — explanation of the error @@ -171,20 +195,44 @@

40 """ 41 42 def __init__(self, message): # pylint: disable=super-init-not-called -43 # TODO: Add data attribute? Timestep? -44 self.message = message +43 self.message = message +44 45 -46 -47class SCSVError(Error): -48 """Exception raised for errors in SCSV file I/O. -49 -50 Attributes: -51 - message — explanation of the error -52 -53 """ -54 -55 def __init__(self, message): # pylint: disable=super-init-not-called +46class IterationError(Error): +47 """Exception raised for errors in numerical iteration schemes. +48 +49 Attributes: +50 message — explanation of the error +51 +52 """ +53 +54 def __init__(self, message): # pylint: disable=super-init-not-called +55 # TODO: Add data attribute? Timestep? 56 self.message = message +57 +58 +59class SCSVError(Error): +60 """Exception raised for errors in SCSV file I/O. +61 +62 Attributes: +63 - message — explanation of the error +64 +65 """ +66 +67 def __init__(self, message): # pylint: disable=super-init-not-called +68 self.message = message +69 +70 +71class ModelContextError(Error): +72 """Exception raised for errors in `mesh.Model` context state. +73 +74 Attributes: +75 message — explanation of the error +76 +77 """ +78 +79 def __init__(self, message): # pylint: disable=super-init-not-called +80 self.message = message @@ -221,6 +269,78 @@

Inherited Members
add_note
args
+ + + + +
+ +
+ + class + MissingDependencyError(Error): + + + +
+ + 
11class MissingDependencyError(Error):
+12    """Exception raised when optional dependencies are missing.
+13
+14    Attributes:
+15        message — explanation of the error
+16
+17    """
+18
+19    def __init__(self, message):  # pylint: disable=super-init-not-called
+20        self.message = message
+
+ + +

Exception raised when optional dependencies are missing.

+ +

Attributes: + message — explanation of the error

+
+ + +
+ +
+ + MissingDependencyError(message) + + + +
+ + 
19    def __init__(self, message):  # pylint: disable=super-init-not-called
+20        self.message = message
+
+ + + + +
+
+
+ message + + +
+ + + + +
+
+
Inherited Members
+
+
builtins.BaseException
+
with_traceback
+
add_note
+
args
+
@@ -236,16 +356,16 @@
Inherited Members
- 
11class ConfigError(Error):
-12    """Exception raised for errors in the input configuration.
-13
-14    Attributes:
-15        message — explanation of the error
-16
-17    """
-18
-19    def __init__(self, message):  # pylint: disable=super-init-not-called
-20        self.message = message
+            
23class ConfigError(Error):
+24    """Exception raised for errors in the input configuration.
+25
+26    Attributes:
+27        message — explanation of the error
+28
+29    """
+30
+31    def __init__(self, message):  # pylint: disable=super-init-not-called
+32        self.message = message
 

 
 
@@ -266,8 +386,8 @@ 
Inherited Members
- 
19    def __init__(self, message):  # pylint: disable=super-init-not-called
-20        self.message = message
+            
31    def __init__(self, message):  # pylint: disable=super-init-not-called
+32        self.message = message
 

 
 
@@ -308,16 +428,16 @@ 
Inherited Members
- 
23class MeshError(Error):
-24    """Exception raised for errors in the input mesh.
-25
-26    Attributes:
-27        message — explanation of the error
-28
-29    """
-30
-31    def __init__(self, message):  # pylint: disable=super-init-not-called
-32        self.message = message
+            
35class MeshError(Error):
+36    """Exception raised for errors in the input mesh.
+37
+38    Attributes:
+39        message — explanation of the error
+40
+41    """
+42
+43    def __init__(self, message):  # pylint: disable=super-init-not-called
+44        self.message = message
 

 
 
@@ -338,8 +458,8 @@ 
Inherited Members
- 
31    def __init__(self, message):  # pylint: disable=super-init-not-called
-32        self.message = message
+            
43    def __init__(self, message):  # pylint: disable=super-init-not-called
+44        self.message = message
 

 
 
@@ -380,17 +500,17 @@ 
Inherited Members
- 
35class IterationError(Error):
-36    """Exception raised for errors in numerical iteration schemes.
-37
-38    Attributes:
-39        message — explanation of the error
-40
-41    """
-42
-43    def __init__(self, message):  # pylint: disable=super-init-not-called
-44        # TODO: Add data attribute? Timestep?
-45        self.message = message
+            
47class IterationError(Error):
+48    """Exception raised for errors in numerical iteration schemes.
+49
+50    Attributes:
+51        message — explanation of the error
+52
+53    """
+54
+55    def __init__(self, message):  # pylint: disable=super-init-not-called
+56        # TODO: Add data attribute? Timestep?
+57        self.message = message
 

 
 
@@ -411,9 +531,9 @@ 
Inherited Members
- 
43    def __init__(self, message):  # pylint: disable=super-init-not-called
-44        # TODO: Add data attribute? Timestep?
-45        self.message = message
+            
55    def __init__(self, message):  # pylint: disable=super-init-not-called
+56        # TODO: Add data attribute? Timestep?
+57        self.message = message
 

 
 
@@ -454,16 +574,16 @@ 
Inherited Members
- 
48class SCSVError(Error):
-49    """Exception raised for errors in SCSV file I/O.
-50
-51    Attributes:
-52    - message — explanation of the error
-53
-54    """
-55
-56    def __init__(self, message):  # pylint: disable=super-init-not-called
-57        self.message = message
+            
60class SCSVError(Error):
+61    """Exception raised for errors in SCSV file I/O.
+62
+63    Attributes:
+64    - message — explanation of the error
+65
+66    """
+67
+68    def __init__(self, message):  # pylint: disable=super-init-not-called
+69        self.message = message
 

 
 
@@ -487,8 +607,8 @@ 
Inherited Members
- 
56    def __init__(self, message):  # pylint: disable=super-init-not-called
-57        self.message = message
+            
68    def __init__(self, message):  # pylint: disable=super-init-not-called
+69        self.message = message
 

 
 
@@ -518,6 +638,78 @@ 
Inherited Members
+
+ +
+ + class + ModelContextError(Error): + + + +
+ + 
72class ModelContextError(Error):
+73    """Exception raised for errors in `mesh.Model` context state.
+74
+75    Attributes:
+76        message — explanation of the error
+77
+78    """
+79
+80    def __init__(self, message):  # pylint: disable=super-init-not-called
+81        self.message = message
+
+ + +

Exception raised for errors in mesh.Model context state.

+ +

Attributes: + message — explanation of the error

+
+ + +
+ +
+ + ModelContextError(message) + + + +
+ + 
80    def __init__(self, message):  # pylint: disable=super-init-not-called
+81        self.message = message
+
+ + + + +
+
+
+ message + + +
+ + + + +
+
+
Inherited Members
+
+
builtins.BaseException
+
with_traceback
+
add_note
+
args
+ +
+
+
+