Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
arkottke committed Apr 6, 2017
1 parent e2bc812 commit 1d6873b
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 32 deletions.
26 changes: 15 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,21 @@ Acceleration response spectrum calculations implemented in Python.
Introduction
------------

Computes the normal and rotated pseudo-acceleration response spectrum of an
earthquake ground motion. The calculation of the response spectrum is performed
using frequency domain transfer functions, as well as frequency domain
interpolation methods to insure that the time step of the motions is greater
than 10 times the natural frequency of the oscillator frequency. Two
perpendicular ground motions can be rotated to compute the response at various
percentiles. For example, the minimum, median, and maximum could be computed
using percentiles of 0, 50, and 100. The orientation of both the minimum and
maximum percentile are provided, but not orientation is provided for other
percentiles because the rotate spectral acceleration is not monotonically
increasing.
Simple Python functions for calculating psuedo-spectral acceleration and
rotated psuedo-spectral acceleration. The response of the
single-degree-of-freedom oscillator is computed in the frequency domain along
with frequency-domain interpolation to accurately capture the high-frequency
characteristics.

The calculation of the response spectrum is performed using frequency domain
transfer functions, as well as frequency domain interpolation methods to insure
that the time step of the motions is greater than 10 times the natural
frequency of the oscillator frequency. Two perpendicular ground motions can be
rotated to compute the response at various percentiles. For example, the
minimum, median, and maximum could be computed using percentiles of 0, 50,
and 100. The orientation of both the minimum and maximum percentile are
provided, but not orientation is provided for other percentiles because the
rotate spectral acceleration is not monotonically increasing.

Installation
------------
Expand Down
32 changes: 12 additions & 20 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,27 +1,19 @@
Welcome to pyrotd's documentation!
==================================

Simple Python functions for calculating psuedo-spectral acceleration and
rotated psuedo-spectral acceleration. The response of the
single-degree-of-freedom oscillator is computed in the frequency domain along
with frequency-domain interpolation to accurately capture the high-frequency
characteristics.
.. include:: ../README.rst

Example
-------
.. toctree::
:maxdepth: 2

.. plot:: ../example.py
:include-source:
api
contributing
example
index

A more thorough example of using the code is provided `here`_

.. _here: https://github.com/arkottke/pyrotd/blob/master/example.ipynb


API
---

.. automodule:: pyrotd
:members:
:undoc-members:
:show-inheritance:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
--index-url https://pypi.python.org/simple/

numpy
setuptools
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
author='Albert Kottke',
author_email='albert.kottke@gmail.com',
url='http://github.com/arkottke/pyrotd',
packages=setuptools.find_packages(),
packages=find_packages(),
install_requires=[
'numpy',
'setuptools',
Expand Down

0 comments on commit 1d6873b

Please sign in to comment.