Merge pull request #420 from IN-CORE/release-4.13.0

Release 4.13.0

CHANGELOG.md

@@ -4,6 +4,16 @@ All notable changes to the INCORE documents generated by Sphinx package will be
 The format is based on [Keep a Changelog](http://keepachangelog.com/) 
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [4.13.0] - 2024-08-21
+
+### Changed
+- Account instructions for registering with keycloak [#416](https://github.com/IN-CORE/incore-docs/issues/416)
+
+### Added
+- Instruction to install pyincore-data [#412](https://github.com/IN-CORE/incore-docs/issues/412)
+
+### Fixed
+- Getting start screenshot with wrong output key [#411](https://github.com/IN-CORE/incore-docs/issues/411)
 
 ## [4.12.0] - 2024-06-12
 

manual_jb/content/_config.yml

@@ -3,7 +3,7 @@ project: "IN-CORE Manual"
 author: IN-CORE Community
 copyright: "2023"  # Copyright year to be placed in the footer
 logo: images/resilience-logo.png
-version: "4.12.0"  # Version is not part of JB config, we use it for autobuild of incore-docs
+version: "4.13.0"  # Version is not part of JB config, we use it for autobuild of incore-docs
 exclude_patterns: [_build, .DS_Store, "**.ipynb_checkpoints"]
 
 repository:

manual_jb/content/account.md

@@ -1,15 +1,14 @@
 # IN-CORE Account
 
-Access to the **IN-CORE** service requires a user account provided and operated by the [NCSA](http://www.ncsa.illinois.edu/) identity management system.
-Registering for an account is free and open to everyone. This account gives you access to all of the public data on
-the system and allows you to create data that is only accessible by you. If applicable, it is recommended
-that you sign up with your institutional email. To register for an account, please go to:
+Access to the **IN-CORE** service requires a user account. Registering for an account is free and open to everyone.
+This account gives you access to all of the public data on the system and allows you to create data that is only
+accessible by you. If applicable, it is recommended that you sign up with your institutional email.
+To register for an account, please go to:
 
-[https://identity.ncsa.illinois.edu/register/BSKC2UKQPU](https://identity.ncsa.illinois.edu/register/BSKC2UKQPU)
+[Registration Link](https://incore.ncsa.illinois.edu/auth/realms/In-core/protocol/openid-connect/registrations?client_id=react-auth&response_type=code&scope=openid&redirect_uri=https://incore.ncsa.illinois.edu/)
 
-![IN-CORE login window](images/register.jpg)
+![IN-CORE login window](images/register.png)
+
+After you register, you will receive an email to finish your registration process. Once this is complete, an
+administrator will need to activate your account before you can access IN-CORE.
 
-After you register, you will receive an email to finish your registration process. 
-It requires you to use 2 Factor Authentication (2FA) using Duo for making sure that you are not a bot. 
-The 2FA is only needed during registration and when changing passwords, it's not required when logging 
-in to IN-CORE services or to use pyIncore.

manual_jb/content/faq.md

@@ -4,13 +4,11 @@
 
 *   *I want to try your IN-CORE services. Do I need to register?*
 
-    A user must have an account [registered](https://identity.ncsa.illinois.edu/register/BSKC2UKQPU) with NCSA IN-CORE service. User credentials are required 
-    in accessing repositories such as hazard, fragility, restoration, geographic and other data sets. 
-    They are also used for accessing documentation server and Jupyter Notebook files.
+    A user must have an account [registered](https://incore.ncsa.illinois.edu/auth/realms/In-core/protocol/openid-connect/registrations?client_id=react-auth&response_type=code&scope=openid&redirect_uri=https://incore.ncsa.illinois.edu/) with NCSA's IN-CORE service.
+    User credentials are required for accessing repositories such as hazard, fragility, restoration, geographic and
+    other data sets. They are also used for accessing IN-CORE when running example Jupyter Notebook files.
 
-    The username/password you chose during registration process in IN-CORE system is called 
-    LDAP password, based on specific Lightweight Directory Access Protocol authentication. 
-    You can test your registration credentials by accessing the [documentation server](http://incore.ncsa.illinois.edu/).
+    You can test your registration credentials by accessing [IN-CORE](http://incore.ncsa.illinois.edu/).
     <br />
     <br />
 

manual_jb/content/getting_started.md

@@ -85,13 +85,24 @@ If you don't have Miniconda installed, do the following steps.
     conda install -c in-core pyincore-viz --solver=libmamba
     ```
 
-   If the installed pyincore or pyincore-viz version is not the latest or lower than the desired one, specify the version number in installation command.
+   The **pyIncore-data** package, available in the in-core conda channel, assists in preparing data for use in 
+   **pyIncore**.
+    ```
+    conda install -c in-core pyincore-data
+    ```
+   Similarly, you can use the libmamba solver flag to resolve the dependencies by running the following command:
+
+    ```
+    conda install -c in-core pyincore-data --solver=libmamba
+    ```
+
+   If the installed pyincore, pyincore-viz, pyincore-data version is not the latest or lower than the desired one, 
+   specify the version number in installation command. e.g.
     ```
     conda install -c in-core pyincore=1.14.0 (or your version of choice)
     ```
-   Version information for pyincore and pyincore-viz can be found in
-   - https://anaconda.org/IN-CORE/pyincore
-   - https://anaconda.org/IN-CORE/pyincore-viz
+   Version information for [pyincore](https://anaconda.org/IN-CORE/pyincore), [pyincore-viz](https://anaconda.org/IN-CORE/pyincore-viz), and [pyincore-data](https://anaconda.org/IN-CORE/pyincore-data) can 
+   be found in [Anaconda IN-CORE space](https://anaconda.org/IN-CORE/repo).
 
 
 6. Install Jupyter Notebook. Jupyter Notebook is already installed with Anaconda distribution; it has to be installed separately in your virtual environment on Miniconda:
@@ -190,7 +201,7 @@ If you don't have Miniconda installed, do the following steps.
     ```
     bldg_dmg.run_analysis()
     ```
-    ![Building damage Jupyter notebook cells.](images/tutorials/tut1_11_juploc_build_dmg.jpg "Building damage Jupyter notebook cells.")
+    ![Building damage Jupyter notebook cells.](images/tutorials/tut1_11_juploc_build_dmg.png "Building damage Jupyter notebook cells.")
     <br />
     <br />
 8. Save your Tutorial notebook by clicking `Save` button in the top bar. Your web page now shows multiple cells of code.