Metadata-Version: 2.1
Name: pbshm-ie-toolbox
Version: 0.1.1
Summary: PBSHM IE Model Toolbox
Author-email: Dan Brennan <d.s.brennan@sheffield.ac.uk>
License: MIT License
        
        Copyright (c) 2022 Dan Brennan
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/dsbrennan/ie-tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: Flask
Requires-Python: >=3.8.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pbshm-core>=1.1.1

# PBSHM IE Toolkit
The PBSHM IE Toolkit is designed to help users interact and design IE models for use within the [PBSHM Core](https://github.com/dynamics-research-group/pbshm-flask-core). The toolkit enables IE models to be either created within the online text editor or upload existing [PBSHM Schema](https://github.com/dynamics-research-group/pbshm-schema) compliant JSON files.

Each IE model is placed within a private users sandbox, each model then goes through two steps of varification. Step 1: Validate the syntax of the IE model against the latest version of the [PBSHM Schema](https://github.com/dynamics-research-group/pbshm-schema). Step 2: Validate that the logic of the IE model holds true (e.g if a grounded model, there should be at least one ground element).

Once a model has passed both stages of validation, this model can then be included in the global IE model catalogue of the system.

For more information about the syntax of an IE model, please read the documentation for the [PBSHM Schema](https://github.com/dynamics-research-group/pbshm-schema).

## Installation
Install the package via pip:
```
pip install pbshm-ie-toolbox
```

## Setup
Firstly, configure the PBSHM Core by following the [outlined guide](https://github.com/dynamics-research-group/pbshm-flask-core#setup)

## Running
The application is run via the standard Flask command:
```
flask run
```

## File size issue
If you get an error when uploading a large IE model, you can add the following line of code into your `pbshm` `__init__.py` file:
```
# Change max content size to 16MB
app.config["MAX_CONTENT_LENGTH"] = 16 * 1000 * 1000
```
