v3.2

[AngRodrigues]

Description

This version is compatible with LPF version available at Loop3D/LoopProjectFile#42

Includes features described in:

PR - #140
PR - #154
PR - #157
PR - #158
PR - #159

Major changes:

1. Merged thickness calculator outputs:
   Methods set_thickness_calculator and get_thickness_calculator still available
   User can now choose up to 5 thickness calculators; also works with user-defined ThicknessCalculator class.
   Default is InterpolatedStructure.
   LPF stores results and name of the thickness calculator as a new field - LoopProjectFile.thicknessCalculatorType, which is a part of the StratigraphicLog object.
   ThicknessCalculatorAlpha updated to logic of the other calculators (e.g., to work from sampled_basal_contacts)

from map2loop.thickness_calculator import ThicknessCalculatorAlpha, InterpolatedStructure, StructuralPoint

[..set up the project..]

project.set_thickness_calculator([StructuralPoint(), InterpolatedStructure()])
project.get_thickness_calculator()

Output:
['StructuralPoint', 'InterpolatedStructure']

2. Minimum fault length
   Minimum fault length is now a parameter of the config file,
   removes the faults with length under defined value; if set to None, minimum fault length is calculated from project's bbox,
   Removed the setter method to avoid double definition; getter method still available through proj.map_data.get_minimum_fault_length()

config_dictionary = {
  "structure" : {
    "dipdir_column": "azimuth2",
    "dip_column": "dip",},
  "geology" : {
    "unitname_column": "unitname",
    "alt_unitname_column": "code"}, 
  "fault": {
      "minimum_fault_length": 0.0}
}

3. added all_basal_contacts object to mapdata
   mapdata.all_basal_contacts -> abnormal+basal contacts ,
   mapdata.basal_contacts -> holds only the basal.
   Reconstruction of sampled_basal_contacts is based on basal_contacts

4. Added folder with datasets in map2loop/_datasets/geodata_files/hamersley
   The idea behind this is to have a data loading function, e.g., at the moment load_hamersley_geology() returns a gdf with the geology; structure and dtm are available, and others will keep being added as needed. This is quite useful for tests, but should also be useful for when we implement [Feature Request] - create map2loop project from geopandas array not file paths #74. The only thing about this is the location, which implies a long import: from map2loop._datasets.geodata_files.hamersley import load_hamersley_geology. Happy to change the file location - if anyone has a better suggestion?

5. Added DependencyChecker class to __init__.py
   This was based on LG's suggestion to check the LPF version on import.
   I decided to expand on this and add this check for all libraries in map2loop/dependencies.txt

6. Added ignore codes both for lithology and faults
   works by feature name, and similar to the existing method.
   Added methods for set and get with _ignore_lithology_codes() and _ignore_fault_codes().
   Example of working example code to achieve this can be seen in map2loop/tests/project/test_ignore_codes_setters_getters.py

Minor changes:

• tmpfile is now used to create the localGdalfile
• changed to f"" strings where possible
• change from os.path.join to pathlib.Path where possible
• added geopandas to csv converter in mapdata (it was on a #TODO)
• added check and error message to make sure that all units in user_defined_stratigraphic_column are in the geology file (otherwise project creation fails; at least now user has a warning).
• renamed distance to stratigraphic_distance in basal_contacts creation
• simplified issue templates for easier form fill

Added tests:

• for some of the functions in mapdata.py (includes minimum_fault_length)
• for thickness_compute in project.py
• ignore_codes setters and getters

Fixes #86
Fixes #110
Fixes #111
Fixes #12
Fixes #143
Fixes #137
Fixes #119
Fixes #155

Type of change

• Documentation update
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Test improvement

How Has This Been Tested?

Branches:

• m2l - https://github.com/Loop3D/map2loop/tree/fix/thicknesses_AR_2
• lpf: https://github.com/Loop3D/LoopProjectFile/tree/fix_thicknesses

⚠️ actions before merging! ⚠️

• - release LPF 0.2
• dependencies.txt need to be updated for the LPF version -> 0.2.1
• make actions same as LPF and m2m (maybe add tests if possible)
• - actions need to be reversed to use LPF main branch. Search for @fix_thicknesses
• - docs docker build needs to be also changed to remove the @fix_thicknesses branch
• - add feat commit for version bump
• add to release notes: set_ignore_codes has change to set_ignore_lithology_codes