Migrated from RST to MD.

arkottke · Feb 8, 2024 · fadd745 · fadd745
1 parent e722815
commit fadd745
Show file tree

Hide file tree

Showing 11 changed files with 65 additions and 207 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,7 @@
 [![PyPi Cheese
 Shop](https://img.shields.io/pypi/v/pyrvt.svg)](https://img.shields.io/pypi/v/pyrvt.svg)
 [![Documentation](https://readthedocs.org/projects/pyrvt/badge/?version=latest)](https://pyrvt.readthedocs.io/?badge=latest)
-[![Build
-Status](https://travis-ci.org/arkottke/pyrvt.svg?branch=master)](https://travis-ci.org/arkottke/pyrvt)
+[![Build status](https://github.com/arkottke/pyrvt/actions/workflows/python-app.yml/badge.svg)](https://github.com/arkottke/pyrvt/actions/workflows/python-app.yml)
 [![Code
 Quality](https://api.codacy.com/project/badge/Grade/4f1fe64804bc45f89b6386666ae20696)](https://www.codacy.com/manual/arkottke/pyrvt)
 [![Test
@@ -19,19 +18,33 @@ acceleration response spectrum.
 Information on the installation and usage can be found in the
 [documentation](https://pyrvt.readthedocs.io/).
 
-# Features
+`pyRVT` provides random vibration theory (RVT) models for use in earthquake
+ground motion models. It provides multiple peak factor models in a common
+framework such that they can be compared and tested. Additionally, it provides
+an interface to define RVT based ground motion models through specification of
+the Fourier amplitude spectrum, acceleration response spectrum, or calculated by
+a seismological models.
 
-Peak factor implementations:
+## Installation
 
-- Vanmarcke (1975)
-- Davenport (1964)
-- Der Kiureghian (1985)
-- Toro & McGuire (1987)
-- Cartwright & Longuet-Higgins (1956)
-- Boore & Joyner (1984)
-- Liu & Pezeshk (1999)
+`pyRVT` can be installed with [pip](https://pip.pypa.io):
 
-# Citation
+```bash
+$ python -m pip install pyrvt
+```
 
-Please cite this software using the
-[DOI](https://zenodo.org/badge/latestdoi/5086299).
+Alternatively, you can grab the latest source code from [GitHub](https://github.com/arkottke/pyrvt):
+
+```
+$ git clone https://github.com/arkottke/pyrvt.git
+$ cd pyrvt
+$ pip install .
+```
+
+## Citation
+
+When citing the software reference the [DOI](https://zenodo.org/records/3630729).
+
+## License
+
+`pyRVT` is made available under the MIT License.
diff --git a/docs/advanced-usage.rst b/docs/advanced-usage.rst
diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/authors.md b/docs/authors.md
@@ -1 +1 @@
---8<-- "CHANGELOG.md"
+--8<-- "AUTHORS.md"
diff --git a/docs/contributing.rst b/docs/contributing.rst
diff --git a/docs/history.rst b/docs/history.rst
diff --git a/docs/index.md b/docs/index.md
@@ -1,13 +1,35 @@
-# Welcome to pyRVT Documentation
+# pyRVT
+
+A Python library and command-line application for using random vibration
+theory to transform between acceleration Fourier amplitude spectrum and
+acceleration response spectrum.
 
 `pyRVT` provides random vibration theory (RVT) models for use in earthquake
 ground motion models. It provides multiple peak factor models in a common
 framework such that they can be compared and tested. Additionally, it provides
-an interface to define RVT based ground motion models through specificiation of
+an interface to define RVT based ground motion models through specification of
 the Fourier amplitude spectrum, acceleration response spectrum, or calculated by
 a seismological models.
 
-## Peak factor models
+## Installation
+
+`pyRVT` can be installed with [pip](https://pip.pypa.io):
+
+```bash
+$ python -m pip install pyrvt
+```
+
+Alternatively, you can grab the latest source code from [GitHub](https://github.com/arkottke/pyrvt):
+
+```
+$ git clone https://github.com/arkottke/pyrvt.git
+$ cd pyrvt
+$ pip install .
+```
+
+## Features
+
+### Peak factor models
 
 The peak calculators and associated functions are contained within
 `pyrvt.peak_calculators`. The primary peak calculators are:
@@ -19,7 +41,7 @@ The peak calculators and associated functions are contained within
 Additional peak calculators are also provided. See the peak calculator
 [API][pyrvt.peak_calculators].
 
-## Ground motion models
+### Ground motion models
 
 Motions for calculating the peak response can be specified by the following
 mechanisms. The frequency content of the motion can be specified by providing
@@ -33,8 +55,16 @@ parameters selected by Campbell (2003)[@campbell03] in a
 optimized functional form provided by Stafford et al. (2022)[@stafford22] in a
 [StaffordEtAl22Motion][pyrvt.motions.StaffordEtAl22Motion].
 
-## Command-line interface
+### Command-line interface
 
 A command-line interface is provided to convert response spectra to Fourier
-amplitude spectra, or vice versa. This inferface as used by Al Atik et al.
+amplitude spectra, or vice versa. This interface as used by Al Atik et al.
 (2014)[@alatik14].
+
+## Citation
+
+When citing the software reference the [DOI](https://zenodo.org/records/3630729).
+
+## License
+
+`pyRVT` is made available under the MIT License.
diff --git a/docs/index.rst b/docs/index.rst
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
diff --git a/docs/zreferences.rst b/docs/zreferences.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -88,4 +88,4 @@ dependencies = [
 [tool.hatch.envs.docs.scripts]
 build = "mkdocs build --clean --strict"
 serve = "mkdocs serve --dev-addr localhost:8000"
-rtfd = 'build -d html'
+rtfd = 'build -d _readthedocs/html'