Getting started¶
SDyPy - Structural Dynamics Python¶
This package has the goal to defragment the open source effort in the scientific field of structural dynamics. Our goal is to speed-up the development and implementation of scientific methods. This an open and free initiative, we stand up for:
free MIT license,
open development,
open accepting of contributions,
open decision making,
multi-institutional engagement.
SDyPy depends on core SciPy stack packages, please use those packages where posible. If you would like an extension to be implemented, if it is general and not related to structural dynamics. consider implementing it into the SciPy stack.
SDyPy pull request guidelines¶
Pull requests are always welcome, and the SDyPy community appreciates any help you give. Note that a code of conduct applies to all spaces managed by the SDyPy project, including issues and pull requests: https://github.com/sdypy/sdypy/blob/master/docs/source/dev/code_of_conduct.rst.
When submitting a pull request, we ask you check the following:
Unit tests, documentation, and code style are in order. For details, please see follow the SciPy notes: https://github.com/scipy/scipy/blob/master/HACKING.rst.txt.
It’s also OK to submit work in progress if you’re unsure of what this exactly means, in which case you’ll likely be asked to make some further changes.
The contributed code will be licensed under SDyPy’s license, https://github.com/sdypy/sdypy/blob/master/LICENSE.txt. If you did not write the code yourself, you ensure the existing license is compatible and include the license information in the contributed files, or obtain a permission from the original author to relicense the contributed code.
Acknowledgements¶
Substantial portions of this document were adapted from the SciPy project’s contributing document.