-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
31 changed files
with
602 additions
and
1,515 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Credits | ||
|
||
## Development Lead | ||
|
||
- Albert Kottke <[email protected]> | ||
|
||
## Contributors | ||
|
||
None yet. Why not be the first? |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Changelog | ||
|
||
## 0.7.0 (dev) | ||
|
||
- Added Stafford et al. (2022) ground motion model. | ||
- Added Boore & Thompson (2015) | ||
- Added Wang & Rathje (2018) | ||
- Re-factored peak factor calculators | ||
- Changed to mkdoc | ||
|
||
## 0.6.3 (2017-10-10) | ||
|
||
- Add scripts for profiling | ||
|
||
## 0.6.2 (2017-05-07) | ||
|
||
- Fixed PEP8 issues in docstrings. | ||
|
||
## 0.6.0 (2017-05-05) | ||
|
||
- Removed pyprind require and progress bars. | ||
|
||
## 0.6.0 (2017-05-05) | ||
|
||
- Improved performance with multiprocessing and numba. | ||
- Changed CLI name from `rvt_operator` to `pyrvt` | ||
|
||
## 0.5.8 (2016-11-16) | ||
|
||
- Fixed: osc_freqs typo in tools.py | ||
- Added: test cases for tools.py | ||
|
||
## 0.5.7 (2016-07-14) | ||
|
||
- Fixed version numbering. | ||
|
||
## 0.5.6 (2016-07-14) | ||
|
||
- Fixed manifest to include data directory. | ||
|
||
## 0.5.5 (2016-07-11) | ||
|
||
- Updated Travis build scripts. | ||
|
||
## 0.5.4 (2016-07-09) | ||
|
||
- Fixed building the documentation on RTFD | ||
|
||
## 0.5.1 (2016-07-06) | ||
|
||
- Fixed Travis deployment | ||
|
||
## 0.5.0 (2016-07-06) | ||
|
||
- Added ability to pass transfer function to PSA calculation. | ||
- Removed extraneous files. | ||
- Cleaned up documentation to use NumPy style. | ||
- Fixed PEP8 issues. | ||
|
||
## 0.1.0 (2016-03-04) | ||
|
||
- First release on PyPI. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
# Contributing | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every | ||
little bit helps, and credit will always be given. | ||
|
||
You can contribute in many ways: | ||
|
||
## Types of Contributions | ||
|
||
### Report Bugs | ||
|
||
Report bugs at https://github.com/arkottke/pyrvt/issues. | ||
|
||
If you are reporting a bug, please include: | ||
|
||
- Your operating system name and version. | ||
- Any details about your local setup that might be helpful in troubleshooting. | ||
- Detailed steps to reproduce the bug. | ||
|
||
### Fix Bugs | ||
|
||
Look through the GitHub issues for bugs. Anything tagged with "bug" | ||
is open to whoever wants to implement it. | ||
|
||
### Implement Features | ||
|
||
Look through the GitHub issues for features. Anything tagged with "feature" | ||
is open to whoever wants to implement it. | ||
|
||
### Write Documentation | ||
|
||
pyRVT could always use more documentation, whether as part of the | ||
official pyRVT docs, in docstrings, or even on the web in blog posts, | ||
articles, and such. Docstrings should be formatted using the | ||
[NumPy conventions](https://numpydoc.readthedocs.io/en/latest/format.html) | ||
|
||
### Submit Feedback | ||
|
||
The best way to send feedback is to file an issue at https://github.com/arkottke/pyrvt/issues. | ||
|
||
If you are proposing a feature: | ||
|
||
- Explain in detail how it would work. | ||
- Keep the scope as narrow as possible, to make it easier to implement. | ||
- Remember that this is a volunteer-driven project, and that contributions | ||
are welcome :) | ||
|
||
## Get Started! | ||
|
||
Ready to contribute? Here's how to set up `pyRVT` for local development. | ||
|
||
1. Fork the `pyRVT` repo on GitHub. | ||
2. Clone your fork locally | ||
|
||
``` | ||
$ git clone [email protected]:your_name_here/pyrvt.git | ||
``` | ||
|
||
3. Create a branch for local development:: | ||
|
||
``` | ||
$ git checkout -b name-of-your-bugfix-or-feature | ||
``` | ||
|
||
Now you can make your changes locally. | ||
|
||
4. When you're done making changes, check that your changes pass formatting and the | ||
tests. | ||
|
||
``` | ||
$ hatch run style:check | ||
$ hatch run test:run | ||
``` | ||
|
||
The documentation can be built with:: | ||
|
||
``` | ||
$ hatch run docs:serve | ||
``` | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
``` | ||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ git push origin name-of-your-bugfix-or-feature | ||
``` | ||
|
||
7. Submit a pull request through the GitHub website. | ||
|
||
## Pull Request Guidelines | ||
|
||
Before you submit a pull request, check that it meets these guidelines: | ||
|
||
1. The pull request should include tests. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.md. | ||
3. The pull request should work for Python 3.7 and later. | ||
|
||
## Tips | ||
|
||
To run tests:: | ||
|
||
``` | ||
$ hatch run test:run | ||
``` |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.