Skip to main content

Framework to build consistent model interfaces

Project description

Latest PyPI version Documentation Status License Build status Coverage

logo

Work in progress! This project is in an early prototyping phase.

What is ‘model-framework’?

Model-framework is a framework to build simple to use Python interfaces for complex models. For instance, a structural analysis tool (like FramAT) requires a number of user inputs parameters, for instance, for general settings, material or loads. It can be cumbersome to develop a consistent user interface for such a tool which has a large number of settings. Model-framework helps to build good Python user API’s for complex models. In particular it aims to improve the following aspects of the developer and user experiences.

  • Providing a simple to understand Python API to build and interact with complex models

  • Enforcing API consistency

  • User input validation

  • Full API documentation through automatic documentation generation

  • Flexible model extensibility

  • Clear separation between user input and solution routines

Please refer do the documentation for more information.

Installation

Model-Framework is available on PyPI and may simply be installed with

pip install model-framework

License

License: Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

model-framework-0.0.20.tar.gz (17.9 kB view details)

Uploaded Source

Built Distribution

model_framework-0.0.20-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file model-framework-0.0.20.tar.gz.

File metadata

  • Download URL: model-framework-0.0.20.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5

File hashes

Hashes for model-framework-0.0.20.tar.gz
Algorithm Hash digest
SHA256 33eb9a14cd085ce520afb7d4e10c82a233dcfaad8079a2483b238ac097a49627
MD5 4de53298fe6134fcb28b118dbf3704f1
BLAKE2b-256 1dfc426985ee8d31e122c52daf39151a5b420a15e3a8644857796822336b04d4

See more details on using hashes here.

Provenance

File details

Details for the file model_framework-0.0.20-py3-none-any.whl.

File metadata

  • Download URL: model_framework-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.4.2 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.5

File hashes

Hashes for model_framework-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 d294d41e25d7bfdcf26b326f5039e6793f18e87c706f79be682a10ebfef419b4
MD5 6d3065b5f7a370525ca405d8b723003d
BLAKE2b-256 f6a73315e3553220e10fbe5fdf1af205132e6336a5ec97b2ba52ed6a7fc89b11

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page