Compare revisions

  image: it4innovations/docker-mdcheck:latest

  allow_failure: true

  script:

  - mdl -r ~MD013,~MD010,~MD014,~MD024,~MD026,~MD029,~MD033,~MD036,~MD037,~MD046 *.md docs.it4i # BUGS

  - find content/docs -name "*.mdx" | xargs mdl -r ~MD002,~MD007,~MD013,~MD010,~MD014,~MD024,~MD026,~MD029,~MD033,~MD036,~MD037,~MD046

pylint:

  stage: test

  script:

  - pylint $(find . -name "*.py" -not -name "feslicescript.py")

pysafety:

capitalize:

  stage: test

  image: it4innovations/docker-pycheck:latest

  image: it4innovations/docker-mkdocscheck:latest

  allow_failure: true

  before_script:

  - source /opt/.venv3/bin/activate

  - python -V # debug

  - pip list | grep titlecase 

  script:

  - cat requirements.txt | safety check --stdin --full-report

capitalize:

  stage: test

  image: it4innovations/docker-mkdocscheck:latest

  script:

  - find mkdocs.yml docs.it4i/ \( -name '*.md' -o -name '*.yml' \) -print0 | xargs -0 -n1 scripts/titlemd.py --test

  - find content/docs/ \( -name '*.mdx' -o -name '*.yml' \) ! -path '*einfracz*' -print0 | xargs -0 -n1 scripts/titlemd.py --test

ext_links:

  stage: after_test

  # remove JSON results

  - rm *.json

  script:

  - find docs.it4i/ -name '*.md' -exec grep --color -l http {} + | xargs awesome_bot -t 10 --allow-dupe --allow-redirect

  - find content/docs -name '*.mdx' -exec grep --color -l http {} + | xargs awesome_bot -t 10 --allow-dupe --allow-redirect

  only:

  - master

  before_script:

  - echo "192.168.101.10 docs.it4i.cz" >> /etc/hosts

  - wget -V

  - echo https://docs.it4i.cz/devel/$CI_BUILD_REF_NAME/

  - wget --spider -e robots=off -o wget.log -r -p https://docs.it4i.cz/devel/$CI_BUILD_REF_NAME/ || true

  - echo https://docs.it4i.cz/devel/$CI_COMMIT_REF_NAME/

  - wget --spider -e robots=off -o wget.log -r -p https://docs.it4i.cz/devel/$CI_COMMIT_REF_NAME/ || true

  script:

  - cat wget.log | awk '/^Found [0-9]+ broken link[s]?.$/,/FINISHED/ { rc=-1; print $0 }; END { exit rc }'

    # get modules list from clusters

  - bash scripts/get_modules.sh

    # generate site_url

  - (if [ "${CI_BUILD_REF_NAME}" != 'master' ]; then sed -i "s/\(site_url.*$\)/\1devel\/$CI_BUILD_REF_NAME\//" mkdocs.yml;fi);

  - (if [ "${CI_COMMIT_REF_NAME}" != 'master' ]; then sed -i "s/\(site_url.*$\)/\1devel\/$CI_COMMIT_REF_NAME\//" mkdocs.yml;fi);

    # generate ULT for code link

#  - sed -i "s/master/$CI_BUILD_REF_NAME/g" material/partials/toc.html

    # regenerate modules matrix

  - echo -e "Host *\n\tStrictHostKeyChecking no\n\n" > ~/.ssh/config

  script:

  - chown nginx:nginx site -R

  - rsync -a --delete site/ root@"$SSH_HOST_STAGE":/srv/docs.it4i.cz/devel/$CI_BUILD_REF_NAME/

  - rsync -a --delete site/ root@"$SSH_HOST_STAGE":/srv/docs.it4i.cz/devel/$CI_COMMIT_REF_NAME/

  only:

  - branches@sccs/docs.it4i.cz

Quantum Scalar I6

JAN

LUMI

AI

CI/CD

AWS

CLI

FAQ

s3cmd

GUI

EESSI

hipBlas

hipSolver

LUMI

apptainer

ROCm

DICE

qgpu

qcpu

it4i-portal-clients

it4icheckaccess

it4idedicatedtime

it4ifree

it4ifsusage

it4iuserfsusage

it4iprojectfsusage

it4imotd

e-INFRA

it4i-portal-clients

s3cmd

s5cmd

title:

e-INFRA CZ Cloud Ostrava

e-INFRA CZ Account

# User Documentation

# IT4Inovations Documentation

This project contains IT4Innovations user documentation source.

## Development

## Migration

### Install

```console

$ sudo apt install libpython-dev

$ virtualenv venv

$ source venv/bin/activate

$ pip install -r requirements.txt

```

### Package Upgrade With pip

```console

$ pip list -o

$ pip install --upgrade package

$ pip freeze | sed '/pkg-resources==/d' > requirements.txt

```

## Environments

* [https://docs.it4i.cz - master branch](https://docs.it4i.cz - master branch)

* [https://docs.it4i.cz/devel/$BRANCH_NAME](https://docs.it4i.cz/devel/$BRANCH_NAME) - maps the branches, available only with VPN access

## URLs

* [http://facelessuser.github.io/pymdown-extensions/](http://facelessuser.github.io/pymdown-extensions/)

* [http://squidfunk.github.io/mkdocs-material/](http://squidfunk.github.io/mkdocs-material/)

```

fair-share

InfiniBand

RedHat

CentOS

Mellanox

```

## Mathematical Formulae

### Formulas Are Made With:

* [https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/](https://facelessuser.github.io/pymdown-extensions/extensions/arithmatex/)

* [https://www.mathjax.org/](https://www.mathjax.org/)

You can add formula to page like this:

```

$$

MAX\_FAIRSHARE * ( 1 - \frac{usage_{Project}}{usage_{Total}} )

$$

```

To enable the MathJX on page you need to enable it by adding line ```---8<--- "mathjax.md"``` at the end of file.

* [fumadocs](https://fumadocs.vercel.app/)

 No newline at end of file

# SCS API v2

## Info

- **OpenAPI:** 3.1.0

- **Title:** scs-api-2

- **Version:** 0.1.0

- **Server URL:** `https://scs.it4i.cz/api/v2`

## Paths

### `/dedicated-time`

**GET**

- **Summary:** Get dedicated times

- **Description:** Retrieves dedicated time entries, optionally filtered by cluster name or period preset

- **OperationId:** `dedicated_time_handler`

**Parameters:**

- `cluster` (query): Filter by cluster name; Available values: karolina, barbora, dgx *(optional)*

- `period` (query): Filter by time period preset; Available values: planned, active *(optional)*

**Responses:**

- `200`: List of dedicated time entries

- `400`: Failed to deserialize query, Invalid cluster, Invalid period

  Example:

  ```json

  {

    "message": "Invalid cluster: el_gordo"

  }

  ```

- `500`: Failed to retrieve dedicated time due to a server error

  Example:

  ```json

  {

    "message": "Failed to retreive dedicated time"

  }

  ```

### `/dedicated-time-calendar`

**GET**

- **Summary:** Get dedicated times

- **Description:** Retrieves dedicated time entries and generates a VCalendar response.

- **OperationId:** `dedicated_time_calendar`

**Responses:**

- `200`: Dedicated time VCalendar

  Example:

  ```

  BEGIN:VCALENDAR

  VERSION:2.0

  PRODID:-//SUTD Timetable Calendar//randName//EN

  CALSCALE:GREGORIAN

  BEGIN:VEVENT

  UID:1234@example.com

  DTSTAMP:20230101T000000Z

  DTSTART:20230101T000000Z

  DTEND:20230102T000000Z

  SUMMARY:Sample Dedicated Time - Cluster Outage

  DESCRIPTION:Sample Dedicated Time - Cluster Outage

  END:VEVENT

  END:VCALENDAR

  ```

- `500`: Failed to retrieve dedicated time calendar

  Example: