Migrated Read docs page (#266)

* Migrated Read docs page * Migrated Read docs page - Added full_socal.csv * Added full_socal.csv * Migrated Read docs page to Jupyter book and added relative markdown links in README.md. Added windows specific command in the get_started.ipynb * Fixed os path * Fixed os path * Fixed os path * Renamed docs folder to docs_old * Addressed the issues
noisepy · Nov 16, 2023 · 92d86a9 · 92d86a9
1 parent 26fb304
commit 92d86a9
Show file tree

Hide file tree

Showing 184 changed files with 57 additions and 45,530 deletions.
diff --git a/.coveragerc b/.coveragerc
@@ -9,7 +9,7 @@ exclude_lines =
     if __name__ == .__main__.:
 ignore_errors = True
 omit =
-    test/*,docs/*
+    test/*,docs_old/*
 
 [html]
 directory = coverage_html_report
diff --git a/.gitignore b/.gitignore
@@ -69,7 +69,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docs_old/_build/
 
 # PyBuilder
 .pybuilder/

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 exclude: |
   (?x)^(
-    docs/conf.py
+    docs_old/conf.py
   )
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -51,7 +51,7 @@ Please follow the [Conventional Commits](https://github.com/uw-ssec/rse-guidelin
 
 ## Overview
 
-<img src="./docs/figures/data_flow.png">
+<img src="./docs_old/figures/data_flow.png">
 The data processing in NoisePy consists of three steps:
 
 1. **(Optional) Step 0 - Download**: The `download()` function or the `noisepy download` CLI command can be

diff --git a/README.md b/README.md
@@ -3,14 +3,14 @@ NoisePy is a Python package designed for fast and easy computation of ambient no
 
 Disclaimer: this code should not be used "as-is" and not run like a blackbox. The user is expected to change local paths and parameters. Submit an issue to github with information such as the scripts+error messages to debug.
 
-Detailed documentation can be found at https://noisepy.readthedocs.io/en/latest/
+Detailed documentation can be found at https://noisepy.github.io/NoisePy/
 
-[![Documentation Status](https://readthedocs.org/projects/noisepy/badge/?version=latest)](https://noisepy.readthedocs.io/en/latest/?badge=latest)
+[![Documentation Status](https://github.com/noisepy/NoisePy/actions/workflows/notebooks.yml/badge.svg)](https://noisepy.github.io/NoisePy/)
 [![Build Status](https://github.com/noisepy/NoisePy/actions/workflows/test.yaml/badge.svg)](https://github.com/noisepy/NoisePy/actions/workflows/test.yaml)
 [![Codecov](https://codecov.io/gh/noisepy/NoisePy/branch/main/graph/badge.svg)](https://codecov.io/gh/noisepy/NoisePy)
 [![DOI](https://zenodo.org/badge/157871462.svg)](https://zenodo.org/badge/latestdoi/157871462)
 
-<img src="https://raw.githubusercontent.com/noisepy/NoisePy/main/docs/figures/logo.png" width="800" height="400">
+<img src="https://raw.githubusercontent.com/noisepy/NoisePy/main/docs_old/figures/logo.png" width="800" height="400">
 
 ## Major updates coming
 NoisePy is going through a major refactoring to make this package easier to develop and deploy. Submit an issue, fork the repository and create pull requests to [contribute](CONTRIBUTING.md).

diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/_build/doctrees/applications.doctree b/docs/_build/doctrees/applications.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/examples.doctree b/docs/_build/doctrees/examples.doctree
diff --git a/docs/_build/doctrees/examples/create_observed_asdf_file.doctree b/docs/_build/doctrees/examples/create_observed_asdf_file.doctree
diff --git a/docs/_build/doctrees/examples/parallel_pyflex.doctree b/docs/_build/doctrees/examples/parallel_pyflex.doctree
diff --git a/docs/_build/doctrees/examples/process_observed.doctree b/docs/_build/doctrees/examples/process_observed.doctree
diff --git a/docs/_build/doctrees/examples/source_receiver_geometry.doctree b/docs/_build/doctrees/examples/source_receiver_geometry.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/installation.doctree b/docs/_build/doctrees/installation.doctree
diff --git a/docs/_build/doctrees/introduction.doctree b/docs/_build/doctrees/introduction.doctree
diff --git a/docs/_build/doctrees/tutorial.doctree b/docs/_build/doctrees/tutorial.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
diff --git a/docs/_build/html/.nojekyll b/docs/_build/html/.nojekyll
diff --git a/docs/_build/html/_sources/applications.rst.txt b/docs/_build/html/_sources/applications.rst.txt
diff --git a/docs/_build/html/_sources/examples.rst.txt b/docs/_build/html/_sources/examples.rst.txt
diff --git a/docs/_build/html/_sources/examples/create_observed_asdf_file.rst.txt b/docs/_build/html/_sources/examples/create_observed_asdf_file.rst.txt
diff --git a/docs/_build/html/_sources/examples/parallel_pyflex.rst.txt b/docs/_build/html/_sources/examples/parallel_pyflex.rst.txt
diff --git a/docs/_build/html/_sources/examples/process_observed.rst.txt b/docs/_build/html/_sources/examples/process_observed.rst.txt
diff --git a/docs/_build/html/_sources/examples/source_receiver_geometry.rst.txt b/docs/_build/html/_sources/examples/source_receiver_geometry.rst.txt
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
diff --git a/docs/_build/html/_sources/installation.rst.txt b/docs/_build/html/_sources/installation.rst.txt
diff --git a/docs/_build/html/_sources/introduction.rst.txt b/docs/_build/html/_sources/introduction.rst.txt