unity-docs
所属分类:聚类算法
开发工具:Python
文件大小:0KB
下载次数:0
上传日期:2023-08-25 16:19:30
上 传 者:
sh-1993
说明: 麻省大学阿默斯特校区Unity Cluster的用户文档,
(User Documentation for Unity Cluster at UMass Amherst ,)
文件列表:
.DS_Store (6148, 2023-08-28)
Dockerfile (447, 2023-08-28)
docs/ (0, 2023-08-28)
docs/.DS_Store (6148, 2023-08-28)
docs/CNAME (24, 2023-08-28)
docs/MGHPCC/ (0, 2023-08-28)
docs/MGHPCC/MGHPCC.md (1524, 2023-08-28)
docs/Software & Tools/ (0, 2023-08-28)
docs/Software & Tools/ColabFold-notebook.md (9856, 2023-08-28)
docs/Software & Tools/ColabFold.md (16479, 2023-08-28)
docs/buy-in/ (0, 2023-08-28)
docs/buy-in/requirements.md (1522, 2023-08-28)
docs/buy-in/types.md (1984, 2023-08-28)
docs/connecting/ (0, 2023-08-28)
docs/connecting/jupyter.md (337, 2023-08-28)
docs/connecting/ood.md (810, 2023-08-28)
docs/connecting/res/ (0, 2023-08-28)
docs/connecting/res/ood-shell-button.png (14531, 2023-08-28)
docs/connecting/res/ood-shell-themes.png (48438, 2023-08-28)
docs/connecting/res/ood-shell.png (93655, 2023-08-28)
docs/connecting/res/putty-host.png (26550, 2023-08-28)
docs/connecting/res/putty-save.png (27114, 2023-08-28)
docs/connecting/res/putty-ssh-key.png (25600, 2023-08-28)
docs/connecting/res/putty-username.png (23723, 2023-08-28)
docs/connecting/res/putty_fingerprint.PNG (109202, 2023-08-28)
docs/connecting/res/ssh_example.PNG (7078, 2023-08-28)
docs/connecting/res/unity_ssh.PNG (25193, 2023-08-28)
docs/connecting/ssh.md (5431, 2023-08-28)
docs/extra.css (755, 2023-08-28)
docs/faq.md (2723, 2023-08-28)
docs/index.md (7128, 2023-08-28)
docs/jargon.md (5748, 2023-08-28)
docs/javascripts/ (0, 2023-08-28)
docs/javascripts/tablesort.js (177, 2023-08-28)
... ...
# Unity Cluster User Documentation
User Documentation for Unity Cluster at UMass Amherst
### Contributing
#### Github Guidelines
We will use branches to propose changes.
Guide for basic git commands: [https://github.com/git-guides](https://github.com/git-guides)
1. Clone the repository using Github Desktop or ssh/https/git-cli.
1. Make a new branch from `main` while following the namescheme: `
/`
1. Setup the local environment to run the documentation locally (described below).
1. Make the desired changes.
1. [Commit](https://github.com/git-guides/git-commit) and [Push](https://github.com/git-guides/git-push) the changes to your branch.
1. Create a [Pull Request](https://docs.github.com/en/pull-requests) while comparing your branch to `main`.
1. List `tlbernardin` and another team member for review.
1. Write a good description for the changes proposed no matter how small.
1. Submit [Pull Request](https://docs.github.com/en/pull-requests).
#### Local Setup
1. Install mkdocs: `pip install mkdocs`
1. Install the theme: `pip install mkdocs-material`
1. Install a plugin: `pip install mkdocs-include-markdown-plugin`
1. Navigate to the root of the repository and run `mkdocs serve`, which will start a web server you can reach from your local browser to test live edits on documentation.
#### Container Setup
You can also build the documentation using a containerized environment.
The following steps can be accomplished via either
[Docker](https://www.docker.com/) or [podman](https://podman.io/).
> **Note**
> If you want to build the nodelist/partitionlist tables, you will need to first download the [private key](https://drive.google.com/file/d/1Q9fJ0QSi3AjLq3vb4e-1kRQgM1NR7eaA/view?usp=sharing) and place it into the same directory as [sheets-to-md/sheets-to-md.py](sheets-to-md/sheets-to-md.py) with the name `unity-sheets-key.json`.
```
podman build -v $(pwd):/unity-docs:z -t unity-docs .
podman run --rm -v $(pwd):/unity-docs:z -p 127.0.0.1:8080:8080 unity-docs
```
Once the above has completed, you can view the live documentation at
http://localhost:8080.
### Updating the nodelist/partitionlist Tables
edit the tables [here](https://docs.google.com/spreadsheets/d/1kEieN7qKY-iiSJc18SVZdyRnJ4NArIhZY_or_WKnIAI/edit?usp=sharing)
get the [private key](https://drive.google.com/file/d/1Q9fJ0QSi3AjLq3vb4e-1kRQgM1NR7eaA/view?usp=sharing) into `unity-docs/sheets-to-md/unity-sheets-key.json`
Install Python modules
```
pip install gspread
pip install tabulate
pip install oauth2client
pip install pandas
```
Generate the tables
```
cd unity-docs/sheets-to-md
./sheets-to-md.py
```
Upload the new tables back to git
近期下载者:
相关文件:
收藏者: