diff --git a/README.md b/README.md index 53cae5da..2b1140f8 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ DesignSafe [MkDocs](https://mkdocs.readthedocs.io/) documentation with **customi 2. [Edit](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files) relevant files that need update.\ ([upload images](https://docs.github.com/en/repositories/working-with-files/managing-files/adding-a-file-to-a-repository) as necessary) 4. [Commit](https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/about-commits) your changes. -5. [Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) a review.\ - (a.k.a. create a "Pull Request") -6. [Test](#testing) your changes.\ +5. [Test](#testing) your changes.\ (if comfortable using a command prompt) - +6. [Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) a review.\ + (a.k.a. create a "Pull Request") + ### Resources * [Markdown syntax (extended)](https://www.markdownguide.org/extended-syntax/) via [MkDocs' Markdown support](https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown) @@ -66,13 +66,21 @@ DesignSafe [MkDocs](https://mkdocs.readthedocs.io/) documentation with **customi 0. Have Docker installed.\ We recommend doing so via [Docker-Desktop](https://www.docker.com/products/docker-desktop). 1. Navigate into your clone of this repository. -2. Start the Docker container to serve the docs. - ```shell +2. Start the Docker container to serve the docs. + + Linux or Mac (macOS) user: + ```shell make build make start ``` -3. Open the website at the URL provided e.g. + Windows user: + ```shell + docker-compose -f docker-compose.yml build + docker-compose -f docker-compose.yml up + + ``` +4. Open the website at the URL provided e.g. [http://0.0.0.1:8000/user-guide/](http://0.0.0.1:8000/user-guide/). diff --git a/user-guide/docs/usecases/padgett/usecase_JN_viz.md b/user-guide/docs/usecases/padgett/usecase_JN_viz.md index d027e43f..a7f0b09c 100644 --- a/user-guide/docs/usecases/padgett/usecase_JN_viz.md +++ b/user-guide/docs/usecases/padgett/usecase_JN_viz.md @@ -18,7 +18,7 @@ The following Jupyter notebook is the basis for the use case described in this s | Scope | Notebook | | :-------: | :---------: | -| visualization of
spatially-distributed Data | visualization_risk_resilience.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/user/silvia/lab/workspaces/auto-k/tree/NHERI-Published/PRJ-3939v3/visualization_risk_resilience.ipynb)| +| visualization of
spatially-distributed Data | visualization_risk_resilience.ipynb
[![Open In DesignSafe](https://raw.githubusercontent.com/geoelements/LearnMPM/main/DesignSafe-Badge.svg)](https://jupyter.designsafe-ci.org/hub/user-redirect/lab/tree/NHERI-Published/PRJ-3939v3/visualization_risk_resilience.ipynb)| diff --git a/user-guide/mkdocs.yml b/user-guide/mkdocs.yml index 0703ab88..2022960c 100644 --- a/user-guide/mkdocs.yml +++ b/user-guide/mkdocs.yml @@ -52,6 +52,7 @@ nav: - ADCIRC: tools/simulation/adcirc/adcirc.md - ClawPack: tools/simulation/clawpack.md - Dakota: tools/simulation/dakota.md + - IN-CORE: tools/simulation/in-core.md - LS-DYNA: tools/simulation/lsdyna.md - OpenFoam: tools/simulation/openfoam.md - OpenSees : tools/simulation/opensees/opensees.md