0.0.1 • Published 2 years ago

@vyzn-tech/acoustic-rating-cli v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

acoustic-rating-cli

acoustic-rating-cli is a Javascript Commandline Tool which calculates acoustic rating requirements for IFC-data according to SIA 181.

Usage

Use the package runner npx to execute acoustic-rating-cli.

$ npx @vyzn-tech/acoustic-rating-cli --help

Options:
  -i, --input-csv <path>                    path to input csv containing IFC-Data
  -eac, --external-acoustic-ratings <path>  path to json containing external-acoustic-ratings
  -o, --output <path>                       path to output.csv
  -f, --force                               force overwrite existing file
  -V, --version                             output the version number
  -h, --help                                display help for command
npx @vyzn-tech/acoustic-rating-cli --input-csv ./example/input.csv --external-acoustic-ratings ./example/external_acoustic_ratings.json --output test.json

Expected Input

A documentation about the required file structure can be found at lib-acoustic-rating.

You can also take a look at some example files here.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT