GitHub URL: https://github.com/ucgmsim/IM_calculation
What is this repo about?
Calculate intensity measures.
Repo status
| README present | Yes |
| Is Public? | Yes |
Number of commits | 302 |
Last time Updated |
|
Functionalities
- Description: State how this function is used or interacts with other sw components.
- Status: (1: not working, 2: unstable, 3: works under specific condition, 4: works with known issues, 5: perfect )
- Tests: (1: none, 2: broken/outdated. 3: with limited coverage, 4: works with known issues, 5: perfect)
- Doc (1: none, 2: outdated, 3: with limited coverage, 4: mostly ok, 5: perfect) Give a link
- Frequency of use: Daily, Weekly, Monthly, Yearly, Never
- Frequency of code/req. change: Daily, Weekly, Monthly, Yearly, Never
- Bus Factor: Number of people that are familiar with the code (1-7)
| Functionality | Description | Status | Known issues | Tests? | Doc? | Frequency of use | Frequency of code/req. change | Bus Factor |
|---|---|---|---|---|---|---|---|---|
| respectra calculations | Calculate spectral acceleration | 5 | test cython rspectra performance vs raw python and refactor if minimal performance drop for increased maintainability/portability | 4 | daily - weekly | yearly | 2 | |
| intensity measures | Calculate different types of intensity measures | 5 | 4 | daily - weekly | yearly | 3 | ||
| read waveform | Contains the class that defines a waveform object and its relevant functionalities. A waveform object is created by reading a binary file/acii files | 4 | TODO should create either a or v not both | 4 | daily - weekly | yearly | 4 | |
| im aggregation | Combines IM files and creates a metadata file | 4 | Can be modularized | 1 (no tests needed) | never | yearly | 2 | |
| calculate ims | Workflow to calculate intensity measures for a given binary file/ascii files | 4 | wiki partially outdated TODO when only geom is needed, only 090 and 000 should be calculated TODO Speed up Ds calculations Argument parser can be simplified (confusing naming etc) | 4 | 4 IM Calculation Refactor(partially outdated) | daily - weekly | yearly | 5 |
| rrup | A collection of functions relating to reading the station and rupture files, taken from the matlab code. | 5 | TODO CODE TO CALCULATE RTVZ AND RX TODO: consider using geopy instead of manual to compute great circle distance between 2 set of (lat, lng) (in degrees) | 4 | 3 | daily - weekly | yearly | 4 |
| calculate rrups | Workflow to calculate rrups for a given station file and a srf file | 4 | No test | 4 | 3 | daily - weekly | yearly | 2 |
Suggested Improvements / New Features
- Description: State how/why this will be useful
| Functionality | Description | Timeline |
|---|---|---|
| calculate ims | Update wiki and github readme docs TODO when only geom is needed, only 090 and 000 should be calculated (33% speed up) TODO: Speed up Ds calculations Argument parser can be simplified (confusing naming etc) | 4 days |
calculate rrups | Develop tests | 4 days |
| rrup | WRITE CODE TO CALCULATE RTVZ AND RX (for empirical engine) http://dap3.dot.ca.gov/ARS_Online/Tech_Docs/Methodology%20for%20Developing%20DRS_12-5-12.pdf TODO: consider using geopy instead of manual to compute great circle distance between 2 set of (lat, lng) (in degrees) | 4 days |
| read waveform | TODO should create either a or v not both | 1 day |
| Cython spectra | test cython rspectra performance vs raw python and refactor if minimal performance drop for increased maintainability/portability | 1 sprint |