Reorg logic tree modules (#38)

- organised the logic tree modules with logical hierarchy
- update changelog and bump version

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.6.0
+current_version = 0.7.0
 commit = True
 tag = True
 

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.7.0] 2024-01-11
+### Added
+ - logic tree base classes
+
+### Changed
+ - source logic tree fault systems now named branch sets. API aliases available for backward compatibility with deprecation warning
+ - source branch tag method changed to property
+
 ## [0.6.0] 2023-12-21
 ### Added
  - GMCM logic tree classes for ground motion model serialization and deserialization (as json or xml)

nzshm_model/__init__.py

@@ -1,7 +1,7 @@
 from . import nshm_v1_0_0, nshm_v1_0_4
 
 # Python package version is different than the NSHM MODEL version !!
-__version__ = '0.6.0'
+__version__ = '0.7.0'
 
 CURRENT_VERSION = "NSHM_v1.0.0"
 

nzshm_model/logic_tree/__init__.py

@@ -0,0 +1,2 @@
+from .gmcm_logic_tree import GMCMBranch, GMCMBranchSet, GMCMLogicTree
+from .source_logic_tree import SourceBranch, SourceBranchSet, SourceLogicTree, SourceLogicTreeV1

nzshm_model/gmcm_logic_tree/logic_tree.py → nzshm_model/logic_tree/gmcm_logic_tree/logic_tree.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass, field
 from typing import Any, Dict, List, Type
 
-from nzshm_model.logic_tree_base import Branch, BranchSet, FilteredBranch, LogicTree
+from nzshm_model.logic_tree.logic_tree_base import Branch, BranchSet, FilteredBranch, LogicTree
 from nzshm_model.psha_adapter import PshaAdapterInterface
 
 

nzshm_model/source_logic_tree/__init__.py → nzshm_model/logic_tree/source_logic_tree/__init__.py

@@ -1,4 +1,4 @@
 from .branch_attribute import BranchAttributeSpec, BranchAttributeValue
 from .version1.logic_tree import SourceLogicTree as SourceLogicTreeV1
 from .version1.logic_tree import SourceLogicTreeCorrelation
-from .version2.logic_tree import SourceLogicTree
+from .version2.logic_tree import SourceBranch, SourceBranchSet, SourceLogicTree

nzshm_model/logic_tree/source_logic_tree/core/__init__.py

@@ -0,0 +1 @@
+from .fault_system_branch_set import BranchSetBase, BranchSetSpec

nzshm_model/source_logic_tree/version1/slt_config.py → nzshm_model/logic_tree/source_logic_tree/version1/slt_config.py

@@ -12,8 +12,8 @@
 from pathlib import Path
 from typing import Any, Dict, Generator, Iterable, List, Union
 
-from nzshm_model.source_logic_tree import BranchAttributeValue
-from nzshm_model.source_logic_tree.version1 import (
+from nzshm_model.logic_tree.source_logic_tree import BranchAttributeValue
+from nzshm_model.logic_tree.source_logic_tree.version1 import (
     Branch,
     FaultSystemLogicTree,
     SourceLogicTree,

nzshm_model/source_logic_tree/version2/logic_tree.py → nzshm_model/logic_tree/source_logic_tree/version2/logic_tree.py

@@ -8,7 +8,7 @@
 from dataclasses import dataclass, field
 from typing import Dict, List, Type, Union
 
-from nzshm_model.logic_tree_base import Branch, BranchSet, FilteredBranch, LogicTree
+from nzshm_model.logic_tree.logic_tree_base import Branch, BranchSet, FilteredBranch, LogicTree
 from nzshm_model.psha_adapter import PshaAdapterInterface
 
 from .. import BranchAttributeValue

nzshm_model/model.py

@@ -3,9 +3,11 @@
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from nzshm_model.logic_tree import SourceLogicTree
+from nzshm_model.logic_tree.source_logic_tree import SourceLogicTreeV1
+
 # from nzshm_model.psha_adapter import NrmlDocument, OpenquakeSimplePshaAdapter
 from nzshm_model.psha_adapter.openquake import NrmlDocument, OpenquakeSimplePshaAdapter
-from nzshm_model.source_logic_tree import SourceLogicTree, SourceLogicTreeV1
 
 if TYPE_CHECKING:
     from nzshm_model.psha_adapter.openquake.logic_tree import LogicTree

nzshm_model/nshm_v1_0_0.py

@@ -1,6 +1,6 @@
 #! nshm_v1_0_0.py
 
-import nzshm_model.source_logic_tree.SLT_v8_gmm_v2_final as slt_config
+import nzshm_model.logic_tree.source_logic_tree.SLT_v8_gmm_v2_final as slt_config
 
 from .model import NshmModel
 

nzshm_model/nshm_v1_0_4.py

@@ -1,7 +1,7 @@
 #! nshm_v1_0_4.py
 
 # Is this only used for the correlations ??
-import nzshm_model.source_logic_tree.SLT_v9p0p0 as slt_config
+import nzshm_model.logic_tree.source_logic_tree.SLT_v9p0p0 as slt_config
 
 from .model import NshmModel
 

nzshm_model/psha_adapter/openquake/simple_nrml.py

@@ -6,10 +6,9 @@
 from lxml import etree
 from lxml.builder import ElementMaker
 
-from nzshm_model.gmcm_logic_tree import GMCMBranch, GMCMBranchSet, GMCMLogicTree
+from nzshm_model.logic_tree import GMCMBranch, GMCMBranchSet, GMCMLogicTree, SourceLogicTree
 from nzshm_model.psha_adapter.openquake.logic_tree import NrmlDocument
 from nzshm_model.psha_adapter.psha_adapter_interface import PshaAdapterInterface
-from nzshm_model.source_logic_tree import SourceLogicTree
 
 try:
     from .toshi import API_KEY, API_URL, SourceSolution

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nzshm-model"
-version = "0.6.0"
+version = "0.7.0"
 description = "The logic tree definitions, final configurations, and versioning of the New Zealand | Aotearoa National Seismic Hazard Model"
 authors = ["Chris DiCaprio <[email protected]>", "Chris Chamberlain <[email protected]>"]
 license = "AGPL3"

tests/psha_adapter/openquake/test_logic_tree_to_simple_nrml.py

@@ -5,9 +5,8 @@
 
 import pytest
 
-from nzshm_model.gmcm_logic_tree import GMCMLogicTree
+from nzshm_model.logic_tree import GMCMLogicTree, SourceLogicTree
 from nzshm_model.psha_adapter.openquake import OpenquakeSimplePshaAdapter
-from nzshm_model.source_logic_tree.version2 import SourceLogicTree
 
 FIXTURE_PATH = Path(__file__).parent.parent.parent / "fixtures"
 

tests/test_correlation.py

@@ -1,6 +1,10 @@
 import unittest
 
-from nzshm_model.source_logic_tree import BranchAttributeSpec, BranchAttributeValue, SourceLogicTreeCorrelation
+from nzshm_model.logic_tree.source_logic_tree import (
+    BranchAttributeSpec,
+    BranchAttributeValue,
+    SourceLogicTreeCorrelation,
+)
 
 
 class TestFlattenedSourceLogicTree(unittest.TestCase):

tests/test_gmcm_filtering.py

@@ -1,6 +1,6 @@
 from pathlib import Path
 
-from nzshm_model.gmcm_logic_tree import GMCMBranch, GMCMLogicTree
+from nzshm_model.logic_tree import GMCMBranch, GMCMLogicTree
 
 gmcm_json_filepath = Path(__file__).parent / 'fixtures' / 'gmcm_logic_tree_example.json'
 

tests/test_gmcm_logic_tree.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from nzshm_model.gmcm_logic_tree.logic_tree import GMCMLogicTree
+from nzshm_model.logic_tree import GMCMLogicTree
 from nzshm_model.psha_adapter.openquake import NrmlDocument
 from nzshm_model.psha_adapter.openquake.simple_nrml import OpenquakeSimplePshaAdapter
 

tests/test_logic_tree.py

@@ -6,8 +6,8 @@
 
 import pytest
 
-from nzshm_model.source_logic_tree.branch_attribute import BranchAttributeSpec
-from nzshm_model.source_logic_tree.version1.logic_tree import (
+from nzshm_model.logic_tree.source_logic_tree.branch_attribute import BranchAttributeSpec
+from nzshm_model.logic_tree.source_logic_tree.version1.logic_tree import (
     Branch,
     BranchAttributeValue,
     CompositeBranch,
@@ -16,7 +16,7 @@
     SourceLogicTree,
     SourceLogicTreeCorrelation,
 )
-from nzshm_model.source_logic_tree.version1.slt_config import from_config
+from nzshm_model.logic_tree.source_logic_tree.version1.slt_config import from_config
 
 
 def test_composite_branch():
@@ -120,7 +120,9 @@ def test_serialise_slt():
 
 class TestSourceLogicTreeSpecification:
     def test_slt_v8(self):
-        config = Path(__file__).parent.parent / 'nzshm_model' / 'source_logic_tree' / 'SLT_v8_gmm_v2_final.py'
+        config = (
+            Path(__file__).parent.parent / 'nzshm_model' / 'logic_tree' / 'source_logic_tree' / 'SLT_v8_gmm_v2_final.py'
+        )
         slt = from_config(config)
 
         slt_spec = slt.derive_spec()

tests/test_logic_tree_new.py

@@ -4,7 +4,7 @@
 # import itertools
 from pathlib import Path
 
-from nzshm_model.source_logic_tree.version2 import SourceLogicTree
+from nzshm_model.logic_tree import SourceLogicTree
 
 # import pytest
 

tests/test_slt_aliases.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from nzshm_model.source_logic_tree.version2 import SourceLogicTree
+from nzshm_model.logic_tree import SourceLogicTree
 
 # import pytest
 

tests/test_slt_config.py

@@ -7,8 +7,8 @@
 import pytest
 
 import nzshm_model
-from nzshm_model.source_logic_tree.version1 import Branch, FaultSystemLogicTree, SourceLogicTree
-from nzshm_model.source_logic_tree.version1.slt_config import (
+from nzshm_model.logic_tree.source_logic_tree.version1 import Branch, FaultSystemLogicTree, SourceLogicTree
+from nzshm_model.logic_tree.source_logic_tree.version1.slt_config import (
     decompose_crustal_tag,
     decompose_subduction_tag,
     from_config,
@@ -86,7 +86,7 @@ def test_assemble_puy(self):
 class TestConfigSerialisation:
     @pytest.mark.parametrize("python_module", ['SLT_v9p0p0.py', 'SLT_v8_gmm_v2_final.py'])
     def test_slt_dict_to_json(self, python_module):
-        config = Path(__file__).parent.parent / 'nzshm_model' / 'source_logic_tree' / python_module
+        config = Path(__file__).parent.parent / 'nzshm_model' / 'logic_tree' / 'source_logic_tree' / python_module
         slt = from_config(config)
         obj = dataclasses.asdict(slt)
         jsonish = json.dumps(obj, indent=2)
@@ -96,7 +96,7 @@ def test_slt_dict_to_json(self, python_module):
     @pytest.mark.parametrize("python_module", ['SLT_v9p0p0.py', 'SLT_v8_gmm_v2_final.py'])
     def test_slt_v8_round_trip(self, python_module):
 
-        config = Path(__file__).parent.parent / 'nzshm_model' / 'source_logic_tree' / python_module
+        config = Path(__file__).parent.parent / 'nzshm_model' / 'logic_tree' / 'source_logic_tree' / python_module
         slt = from_config(config)
         obj = dataclasses.asdict(slt)
         jsonish = json.dumps(obj, indent=2)
@@ -118,7 +118,9 @@ def test_slt_v8_round_trip(self, python_module):
 
 class TestFromConfig:
     def test_slt_v8(self):
-        config = Path(__file__).parent.parent / 'nzshm_model' / 'source_logic_tree' / 'SLT_v8_gmm_v2_final.py'
+        config = (
+            Path(__file__).parent.parent / 'nzshm_model' / 'logic_tree' / 'source_logic_tree' / 'SLT_v8_gmm_v2_final.py'
+        )
         slt = from_config(config)
         print(slt)
         assert slt.fault_system_lts[0].branches[-1].values[0].name == 'dm'

tests/test_slt_filtering.py

@@ -4,8 +4,7 @@
 import pytest
 
 import nzshm_model
-from nzshm_model.source_logic_tree import SourceLogicTree
-from nzshm_model.source_logic_tree.version2 import SourceBranch
+from nzshm_model.logic_tree import SourceBranch, SourceLogicTree
 
 
 ## three example filter functions

tests/test_slt_iteration.py

@@ -6,8 +6,8 @@
 import pytest
 
 import nzshm_model
-from nzshm_model.source_logic_tree import SourceLogicTree, SourceLogicTreeV1
-from nzshm_model.source_logic_tree.version2 import SourceBranch, SourceBranchSet
+from nzshm_model.logic_tree import SourceBranch, SourceBranchSet
+from nzshm_model.logic_tree.source_logic_tree import SourceLogicTree, SourceLogicTreeV1
 
 
 @pytest.fixture(scope='module')

tests/test_slt_version_migration.py

@@ -4,7 +4,7 @@
 import pytest
 
 import nzshm_model
-from nzshm_model.source_logic_tree import SourceLogicTree, SourceLogicTreeV1
+from nzshm_model.logic_tree.source_logic_tree import SourceLogicTree, SourceLogicTreeV1
 
 
 @pytest.fixture(scope='module')