================
Get Started
================
| You can start to use ARIM-mdx by following these steps:
A. **Getting and Activating Personal Account**
B. **Getting 30TB Group Folder**
C. **Jupyter Initial Setup**
.. note:: This process takes **10-15 minutes** in total.
A. Getting and Activating Personal Account
----------------------------------------------------
A-1. Getting Your Account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You will get your accounts and initial passwords depending on the user type:
.. raw:: html
(i) For ARIM Facility Users
| 1-1. Get the account and initial password issued by your ARIM facility.
.. raw:: html
| 1-1. Submit your project's application through this `Application Form (Japanese) `_.
| 1-2. Get the account and initial password issued by the ARIM-mdx administrator after the application.
.. note::
If you are **already registered for another project**, continue to `B. Getting 30TB Group Folder`_ using your own account (email address).
A-2. Change Your Initial Password
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| 2-1. Access https://arim.mdx.jp/nextcloud.
.. image:: _static/init-login.png
:alt: init-login
:align: center
:width: 400px
|
| 2-2. Log in with your account and initial password.
.. image:: _static/login-2.png
:alt: login-2
:align: center
:width: 400px
|
| 2-3. Renew your password.
.. image:: _static/login-3.png
:alt: login-3
:align: center
:width: 400px
|
| 2-4. Register your information.
.. image:: _static/login-4.png
:alt: login-4
:align: center
:width: 400px
|
A-3. Email Verification
^^^^^^^^^^^^^^^^^^^^^^^
| 3-1. Check the verification email sent to your registered email address.
.. image:: _static/login-5.png
:alt: login-5
:align: center
:width: 400px
|
| 3-2. Click the link in the email to verify.
| 3-3. Check to visit https://arim.mdx.jp/nextcloud.
.. image:: _static/login-6.png
:alt: login-6
:align: center
:width: 400px
|
.. note::
After verification, you can log in using either your ID or **email address**.
.. warning::
Some email addresses may not receive the verification email due to spam filtering.
In such cases, please contact the system administrator or password issuer.
B. Getting 30TB Group Folder
-----------------------------
Follow these steps to activate your group's 30TB shared folder.
.. note::
The following steps should be performed by the group representative.
B-1. Getting Group Management URL
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Get your **Group Management Private URL** that was provided with your personal account.
If you cannot find it, contact your account issuer or ARIM-mdx's administrator.
.. warning::
**Keep this URL confidential and secure.** Anyone who has this URL can access group management settings.
If you suspect unauthorized access or URL disclosure, immediately contact ARIM-mdx's system administrator.
B-2. Logging into Group Management
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| 2-1. Access your **Group Management URL** and log in with your account.
.. image:: _static/login-6.png
:alt: login-6
:align: center
:width: 400px
|
| 2-2. Enter ARIM-mdx User Group Management. Registered accounts in this group will be displayed.
.. image:: _static/user-group-management.png
:alt: user-group-management
:align: center
:width: 500px
|
B-3. Adding Group Users
^^^^^^^^^^^^^^^^^^^^^^^^^^
| 3-1. Enter the user's account (email address) you want to register in ``Enter email`` and click **ADD**.
.. image:: _static/add-user.png
:alt: add-user
:align: center
:width: 500px
|
.. note::
The registered email address can be found at https://arim.mdx.jp/nextcloud via ``top-right icon`` > ``View Profile``
| 3-2. The user is registered, and the shared folder becomes available
.. image:: _static/user-added.png
:alt: added-user
:align: center
:width: 500px
|
B-4. Confirming in Nextcloud
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| 4-1. From https://arim.mdx.jp/nextcloud, **log out first, then log in again**.
| 4-2. After logging in, the added Group folder (e.g., 24UT0000) appears in the **⌂ / large** folder.
.. image:: _static/check-nextcloud.png
:alt: check-user
:align: center
:width: 500px
|
B-5. (Optional) Removing Users
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| 5-1. Click ``Delete`` for the user you want to remove.
.. image:: _static/delete-user.png
:alt: delete-user
:align: center
:width: 500px
|
| 5-2. Reload your browser. The deleted user disappeared.
.. image:: _static/user-deleted.png
:alt: deleted-user
:align: center
:width: 500px
|
.. _jupyter-activation:
C. Jupyter Initial Setup
--------------------------
Follow these steps to integrate Nextcloud with Jupyter.
C-1. Logging into Jupyter
^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Log in to ARIM-mdx Jupyter service (https://jupyter.arim.mdx.jp).
.. image:: _static/login-6.png
:alt: login-6
:align: center
:width: 400px
|
C-2. Starting Jupyter Server
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| Select a server and click **Start** to launch (any spec type is fine).
.. image:: _static/jupyter-spec.png
:alt: jupyter-spec
:align: center
:width: 500px
|
.. .. list-table::
.. :header-rows: 1
.. :widths: 40 60
.. * - Type
.. - Description
.. * - Jupyter / VSCode / Remote Desktop
.. - Environment including Remote Desktop (`MateriApps LIVE! `_)
.. * - Jupyter / VSCode Only
.. - Environment with only JupyterLab and VSCode
.. .. list-table::
.. :header-rows: 1
.. :widths: 20 40 40
.. * - Type
.. - Specifications
.. - Description
.. * - Default
.. - 8 cores, 12GB memory
.. - Standard computing environment
.. * - High Spec
.. - 16 cores, 24GB memory
.. - High-performance PC equivalent
.. * - Max Spec
.. - 48 cores, 72GB memory
.. - High-performance server equivalent
.. note::
Starting Jupyter may take up to several minutes.
C-3. Running ``README.ipynb``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
| 3-1. After startup, open and run the ``README.ipynb`` file in the folder (click the ▶︎ button).
.. image:: _static/readme.png
:alt: readme
:align: center
:width: 500px
|
| 3-2. When you run the second line, you'll be redirected to ARIM-mdx Nextcloud to authorize the account integration.
.. image:: _static/nextcloud-connect.png
:alt: nextcloud-connect
:align: center
:width: 500px
|
| 3-3. After ARIM-mdx Nextcloud access authentication is complete, return to Jupyter and continue running ``README.ipynb``. After running all lines, a new ``arim-mdx`` folder will be created.
.. image:: _static/arim-mdx-appear.png
:alt: arim-mdx-appear
:align: center
:width: 500px
|
| 3-4. Initial setup is complete when the ``arim-mdx`` folder synchronizes with your ARIM-mdx Nextcloud home folder, and you can access ``large/24UTXXXXX`` etc. For subsequent logins, it will automatically connect with ARIM-mdx Nextcloud.
.. image:: _static/sync-nextcloud.png
:alt: sync-nextcloud
:align: center
:width: 500px
|