brails 4.1.4

BRAILS++: Building Regional Asset Inventories for Large Scale Simulation

<h1 style=”text-align: center;”>BRAILS++: Building Regional Asset Inventories for Large Scale Simulation</h1>

[](https://github.com/NHERI-SimCenter/BrailsPlusPlus/actions/workflows/tests.yml/badge.svg) [](https://zenodo.org/badge/latestdoi/184673734) [](https://pypi.org/project/BRAILS/) [](https://pypi.python.org/pypi/BRAILS/)

## What is it?

`BRAILS++` is an object-oriented framework for building applications that focus on generating asset inventories for large geographic regions.

## How is the repo laid out?

• `brails`: A directory containing the classes - `brails/types`: directory containing useful datatypes, e.g., `ImageSet` and `AssetInventory` - `brails/processors`: directory containing classes that do `image_processing` to make predictions, e.g. RoofShape - `brails/scrapers`: directory containing classes that do internet downloads, e.g., footprint and image scrapers. - `brails/filters`: directory containing image filters, e.g., classes that take images and revise or filter out unnecessary portions of images. - `brails/imputers`: directory containing classes that fill in missing `AssetInventory` datasets, i.e., filling in features that are missing in certain Assets of the AssetInventory. - `brails/inferers`: directory containing classes that infer new asset features based on existing features in the Assets of `AssetInventory`. - `brails/utils`: directory containing misc classes that do useful things, e.g. geometric conversions

• `examples`: A directory containing example scripts and Jupyter notebooks

• `tests`: A directory containing unit tests. The directory structure follows that of `brails`

## Quick Links

• [Documentation & Guides](https://nheri-simcenter.github.io/BrailsPlusPlus/)

## Installation instructions

`shell pip install brails `

## Acknowledgments

This work is based on material supported by the National Science Foundation under grants CMMI 1612843 and CMMI 2131111.

## Contributors

Want to see who made this possible? Check out the full list of contributors [here](./contributors.md).

## Contact

NHERI-SimCenter [e-mail]

<!– todo: instructions on how to lint the code, and specific subfolder or file. –> <!– todo: example with the test suite. –> <!– todo: instructions on how to run the tests –> <!– todo: instructions on how to check coverage –> <!– python -m pytest tests –cov=brails –cov-report html –>