oasislmf 1.1.27

Core loss modelling framework.

OasisLMF

The oasislmf Python package provides a Python toolkit for building, running and testing Oasis models end-to-end, including performing individual steps in this process. It includes:

• a Python class framework for working with Oasis models and model resources as Python objects (the oasislmf.models subpackage)
• a Python class framework for managing model exposures and resources, and also for generating Oasis files from these (the oasislmf.exposures subpackage)
• a Python factory class for instantiating keys lookups for models, and generating and saving keys outputs from these lookups (the oasislmf.keys subpackage)
• a command line interface for running models end-to-end, including performing individual steps:
  • generating keys from model keys lookups, and writing them as files: oasislmf model generate-keys
  • generating Oasis files (GUL only at present, FM to be added later) from source exposure files, canonical profiles, exposure validation and transformation files, and keys data files: oasislmf model generate-oasis-files
  • generating losses from Oasis files and analysis settings: oasislmf model generate-losses
  • running a model end-to-end: oasislmf model run

Installation

Dependencies

GNU/Linux

• Debian: g++ compiler build-essential, libtool, zlib1g-dev autoconf on debian distros
• Red Hat: 'Development Tools' and zlib-devel

Windows

Cygwin 64-bit is required for the Windows native build. Cygwin is a Linux environment running in Windows. http://www.cygwin.com/

Download and run the set-up program for Cygwin. The following Cygwin add-in packages are required;

• gcc-g++
• gcc-core
• make
• diffutils
• automake
• libtools
• zlib-devel
• git

To build native Windows 64-bit executables;

• mingw64-x86_64-gcc-g++
• mingw64-x86_64-gcc-core
• mingw64-x86_64-zlib

Search for 'mingw', gcc', 'make' and 'diffutils' to find all of the relevant packages (Only 'gcc' illustrated below).

Install With pip (or pip3)

The latest released version of the package can be installed using pip (or pip3 if using Python 3):

pip install oasislmf

Alternatively you can install the latest development version using:

pip install git+{https,ssh}://[e-mail]/OasisLMF/OasisLMF

You can also install from a specific branch <branch name> using:

pip install git+{https,ssh}://[e-mail]/OasisLMF/OasisLMF.git@<branch name>#egg=oasislmf

Model specific dependencies

Specific models have Python requirements and systems library requirements of their own, and without installing these some of the MDK commands any fail. For example, PiWind requires shapely, pandas, and Rtree Python packages (in addition to oasislmf), as well as the libspatialindex-dev spatial indexing system library (for which RTree is a Python wrapper). You must install these before using the MDK commands against PiWind.

Development

Dependencies

Dependencies are controlled by pip-tools. To install the development dependencies first, install pip-tools using:

pip install pip-tools

and run:

pip-sync

To add new dependencies to the development requirements add the package name to requirements.in or to add a new dependency to the installed package add the package name to requirements-package.in. Version specifiers can be supplied to the packages but these should be kept as loose as possible so that all packages can be easily updated and there will be fewer conflict when installing.

After adding packages to either *.in file:

pip-compile && pip-sync

should be ran ensuring the development dependencies are kept up to

Testing

To test the code style run:

flake8

To test against all supported python versions run:

tox

To test against your currently installed version of python run:

py.test

To run the full test suite run:

./runtests.sh

Publishing

Before publishing the latest version of the package make you sure increment the __version__ value in oasislmf/__init__.py, and commit the change. You'll also need to install the twine Python package which setuptools uses for publishing packages on PyPI. If publishing wheels then you'll also need to install the wheel Python package.

Using the publish subcommand in setup.py

The distribution format can be either a source distribution or a platform-specific wheel. To publish the source distribution package run:

python setup.py publish --sdist

or to publish the platform specific wheel run:

python setup.py publish --wheel

Manually publishing, with a GPG signature

The first step is to create the distribution package with the desired format: for the source distribution run:

python setup.py sdist

which will create a .tar.gz file in the dist subfolder, or for the platform specific wheel run:

python setup.py bdist_wheel

which will create .whl file in the dist subfolder. To attach a GPG signature using your default private key you can then run:

gpg --detach-sign -a dist/<package file name>.{tar.gz,whl}

This will create .asc signature file named <package file name>.{tar.gz,whl}.asc in dist. You can just publish the package with the signature using:

twine upload dist/<package file name>.{tar.gz,whl} dist/<package file name>.{tar.gz,whl}.asc

Documentation

• Issues
• Releases
• General Oasis documentation
• Model Development Kit (MDK)
• Modules

License

The code in this project is licensed under BSD 3-clause license.