{"id":20596263,"url":"https://github.com/ulhpc/ulhpc-docs","last_synced_at":"2025-04-14T23:50:31.769Z","repository":{"id":147481762,"uuid":"498475084","full_name":"ULHPC/ulhpc-docs","owner":"ULHPC","description":"ULHPC Technical Documentation (mkdocs-based) - https://hpc-docs.uni.lu","archived":false,"fork":false,"pushed_at":"2025-04-07T19:31:35.000Z","size":99160,"stargazers_count":8,"open_issues_count":10,"forks_count":9,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-07T20:33:27.994Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ULHPC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing/README.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/support/index.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-31T19:42:24.000Z","updated_at":"2025-04-07T19:30:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"f68a5e69-ef83-4599-84d3-edc5430c226f","html_url":"https://github.com/ULHPC/ulhpc-docs","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fulhpc-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fulhpc-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fulhpc-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ULHPC%2Fulhpc-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ULHPC","download_url":"https://codeload.github.com/ULHPC/ulhpc-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248981259,"owners_count":21193144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T08:16:00.622Z","updated_at":"2025-04-14T23:50:31.753Z","avatar_url":"https://github.com/ULHPC.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![By ULHPC](https://img.shields.io/badge/by-ULHPC-blue.svg)](https://hpc.uni.lu) [![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](LICENSE) [![GitHub issues](https://img.shields.io/github/issues/ULHPC/ulhpc-docs)](https://github.com/ULHPC/ulhpc-docs/issues) [![Github](https://img.shields.io/badge/sources-github-green.svg)](https://github.com/ULHPC/ulhpc-docs/) ![Build Status](https://img.shields.io/github/workflow/status/ULHPC/ulhpc-docs/deploy) [![GitHub forks](https://img.shields.io/github/forks/ULHPC/ulhpc-docs?style=social)](https://github.com/ULHPC/ulhpc-docs) [![Github Stars](https://img.shields.io/github/stars/ULHPC/ulhpc-docs?style=social)](https://github.com/ULHPC/ulhpc-docs) [![deploy](https://github.com/ULHPC/ulhpc-docs/actions/workflows/deploy.yml/badge.svg)](https://github.com/ULHPC/ulhpc-docs/actions/workflows/deploy.yml) [![pages-build-deployment](https://github.com/ULHPC/ulhpc-docs/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/ULHPC/ulhpc-docs/actions/workflows/pages/pages-build-deployment)\n\n         _    _ _      _    _ _____   _____   _______        _           _           _   _____\n        | |  | | |    | |  | |  __ \\ / ____| |__   __|      | |         (_)         | | |  __ \\\n        | |  | | |    | |__| | |__) | |         | | ___  ___| |__  _ __  _  ___ __ _| | | |  | | ___   ___ ___\n        | |  | | |    |  __  |  ___/| |         | |/ _ \\/ __| '_ \\| '_ \\| |/ __/ _` | | | |  | |/ _ \\ / __/ __|\n        | |__| | |____| |  | | |    | |____     | |  __/ (__| | | | | | | | (__ (_| | | | |__| | (_) | (__\\__ \\\n         \\____/|______|_|  |_|_|     \\_____|    |_|\\___|\\___|_| |_|_| |_|_|\\___\\__,_|_| |_____/ \\___/ \\___|___/\n\n\n       Copyright (c) 2020-2022 S. Varrette and UL HPC Team \u003chpc-team@uni.lu\u003e\n\nThis repository holds the [ULHPC Technical Documentation](https://hpc-docs.uni.lu), based on the [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/) theme and the [PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions/).\nInspired by the _excellent_ [NERSC Technical documentation](https://docs.nersc.gov/).\n\n\n## Installation / Repository Setup\n\nThis repository is hosted on [Github](https://github.com/ULHPC/ulhpc-docs). To clone it, proceed as follows (adapt accordingly):\n\n```bash\ngit clone https://github.com/ULHPC/ulhpc-docs.git # or for SSH interactions: git clone git@github.com:ULHPC/ulhpc-docs.git\n```\n\nTo use the repository, you need to install some Python packages along with a compatible version of Python. If your system Python is compatible, simply install the packages in `requirements.txt`, ideally in a `venv`. For instance:\n```\n$ python3 -m venv \"${HOME}/environments/ulhpc-docs\"\n$ source ~/environments/ulhpc-docs/bin/activate\n$ pip install --upgrade pip\n$ pip install --requirement requirements.txt\n```\n\nIf your system Python is not compatible with the required packages, we suggest that you install Python in a Conda environment using the [Micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html) package manager for Conda.\n\n- Begin by [installing the Micromamba package manager](https://mamba.readthedocs.io/en/latest/installation/micromamba-installation.html).\n- Install Python 3.8 in a new environment.\n```\n$ micromamba env create --name ulhpc-docs-python\n$ micromamba install python=3.8 --channel conda-forge --name ulhpc-docs-python\n```\n- You now have 2 options. First options is to install the required python packages directly in the Conda environment.\n```\n$ micromamba activate ulhpc-docs-python\n$ pip install --upgrade pip\n$ pip install --requirement requirements.txt\n```\n- Alternatively, you can create a `venv` environment in which you install the packages.\n```\n$ micromamba run --name ulhpc-docs-python python -m venv \"${HOME}/environments/ulhpc-docs\"\n$ source ~/environments/ulhpc-docs/bin/activate\n$ pip install --upgrade pip\n$ pip install --requirement requirements.txt\n```\n\nThe `ulhpc-docs` `venv` environment will automatically use the Python installed in the Conda environment `ulhpc-docs-python`. In the later case you will no longer need to interact with the Conda environment, except perhaps for updating the Python executable.\n\n# Documentation\n\nSee [`docs/`](docs/README.md).\n\nThe documentation for this project is handled by [`mkdocs`](http://www.mkdocs.org/#installation) with the [mkdocs-material](https://squidfunk.github.io/mkdocs-material/getting-started/) theme and the [PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions/).\nYou might wish to generate locally the docs (**after** setting up your local virtualenv) i.e. to preview the documentation from the project root directory by running:\n\n```bash\nmkdocs serve    # OR make doc\n```\n\nThen visit with your favorite browser the URL `http://localhost:8000`. Alternatively, you can run `make doc` at the root of the repository.\n\n## Reporting Issues / Feature request\n\nYou can submit bug / issues / feature request with our documentation using the [`ULHPC/ulhpc-docs` Issue Tracker](https://github.com/ULHPC/ulhpc-docs/issues).\n\n\n## Software list\n\nSeveral markdown files under `docs/software/swsets/` reflect the state of the software modules available on the ULHPC platform. They respect the following directory structure:\n\n```\ndocs/software/swsets/\n    ├── all_softwares.md   list of all software ever built\n    ├── \u003cversion\u003e.md       software list in RESIF swset \u003cversion\u003e\n    ├── \u003ccategory\u003e.md      list of all software belonging to category '\u003ccategory\u003e'\n    └── \u003ccategory\u003e/\n    .   ├── \u003csoftware\u003e.md    short summary and available version for software \u003csoftware\u003e\n    .   └── [...]            belonging to category \u003ccategory\u003e\n```\n\nThese files are **automatically** generated by the Python script [`scripts/resif3_module2markdown.py`](scripts/resif3_module2markdown.py):\n\n```bash\n$ ./scripts/resif3_module2markdown.py -h\nUsage: resif3_module2markdown.py [OPTIONS] COMMAND [ARGS]...\n[...]\nCommands:\n  collect  Collect meta-data dict of the RESIF3 modules installed and...\n  render   Generate markdown files summarizing available ULHPC modules\n```\n\n* `./scripts/resif3_module2markdown.py collect [...]` is **expected to by run on one of the cluster** to access the RESIF root path `/opt/apps/resif`\n     - use **`make resif-collect`** to perform the following operations:\n          * upload the script and the necessary files on the cluster access frontend (see `RESIF_COLLECT_HOST` variable in [`.Makefile.local`](.Makefile.local))\n          * generate a virtualenv under `RESIF_COLLECT_TMPDIR`\n          * invoke the script in `collect` mode to generate the YAML file `RESIF_COLLECT_YAML`\n          * download the generated yaml and store it under [`data/resif_modules.yaml`](data/resif_modules.yaml)\n*  `./scripts/resif3_module2markdown.py render [...]` can be used locally to render/generate the markdown files **based on the data stored in [`data/resif_modules.yaml`](data/resif_modules.yam)**\n    - use **`make resif-render`** to perform this action\n\n\n## Contributors\n\nThe project was setup and populated by Sebastien Varrette, and received contributions from multiples persons -- see [`CONTRIBUTORS.md`](CONTRIBUTORS.md). \nTo get up-to-date statistics, use\n\n```bash \nmake stats\n````\n\nIn all cases, you are more than welcome to contribute to the development of this project.\nIn order to get started, check out the [Contributing Guide](docs/contributing/README.md)\n\n## License\n\nUnless otherwise specified, this project and the sources proposed within this repository are released under the terms of the [CC BY-NC-SA 4.0](LICENSE) licence.\n\n[![](https://upload.wikimedia.org/wikipedia/commons/thumb/1/12/Cc-by-nc-sa_icon.svg/176px-Cc-by-nc-sa_icon.svg.png)](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulhpc%2Fulhpc-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fulhpc%2Fulhpc-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulhpc%2Fulhpc-docs/lists"}