Metadata-Version: 2.1
Name: threedi-modelchecker
Version: 0.2
Summary: Checks validity of a threedi-model
Home-page: https://github.com/nens/threedi-modelchecker
Author: Richard Boon
Author-email: richard.boon@nelen-schuurmans.nl
License: MIT
Description: # Threedi-modelchecker
        
        Threedi-modelchecker is a tool to verify the correctness of a 3Di model.
        The goal is to provide a tool for model builders to quickly check if his/her 
        model is correct and can run a 3Di simulation. It provides detailed 
        information about any potential errors in the model.
        
        Threedi-modelchecks works with both spatialite and postgis databases. However, 
        the database should always have the latest 3Di migration: https://docs.3di.lizard.net/en/stable/d_before_you_begin.html#database-overview 
        
        Installation:
        
            $ pip install threedi-modelchecker
        
        
        Threedi-modelchecker is also integrated into the ThreediToolbox Qgis plugin: https://github.com/nens/ThreeDiToolbox
        
        # Development
        
        A docker image has been created for easy development. It contains an postgis 
        server with an empty 3Di database to allow for easy testing.
        
        Build the image:
        
            # docker-compose build
        
        Run the tests:
        
            $ docker-compose run modelchecker pytest
        
        
        Changelog of threedi-modelchecker
        ===================================================
        
        
        0.2 (2019-06-12)
        ----------------
        
        - Renamed some methods of ThreediModelChecker.
        - Added basic to the 3di model schema: checks if the model has the latest migration 
          applied and raises an error if not.
        - Rewrote CrossSectionShape check to no longer use regex and added it to config.
        
        
        0.1 (2019-06-04)
        ----------------
        
        - Initial project structure.
        - Added ORM for a threedi-model in sqlalchemy.
        - Added several types of checks.
        - Manually configured many checks.
        - Added check factories, which generate many checks based on the ORM.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
Provides-Extra: test
