---
# System prepended metadata

title: Python docs update 2022

---

# Python docs update 2022


## Thomas
## Overall idea:					
Be consistent and define what is our "suggested way", potentially warning against other approaches and giving the reason for it.					
If there are alternative ways that's fine, but We should not "suggest" something that we actively discourage ( like e.g. at the moment pip install --user still being the way indicated under "Install your own packages easily".)					
We might want to merge pages, or at least page content, like e.g. Data Storage currently has entries under "Aalto Tools", "Data" and "Triton cluster" making it seem "all over the place.					
Same applies to Python ( 2 under triton/apps one under Aalto Tools, One under scicomp tips ...).					
					
					
					
## General Menu structure:		


| Page     |SubPage   | Content  | Comment | 
| -------- | -------- | -------- | --------|
| Landing  |          |          |         |
|          |Welcome Researchers| |	Doesn't need it's own Menu item                                     (imo) but can be linked to from the Landing page, asis currently done.|
| |	Welcome Students |           |         | 
|News      |          |          |Needs to be more regularily updated, potentially with "upcoming Courses" and should be directly linked on the Landing page. |
| Aalto Tools|   |				|	Pages need regular updates. (e.g. the Linux page says that ubuntu 20.04 is coming soon to aalto linux... ), Possibly give a bit more info on common questions like "Admin access" etc? Potentially update name to something like "Tools and Procedures at Aalto", because there are several Policy pages under this header, OR move the Policies to a different topic.				
|Triton Cluster:|||					Can we have a "current Usage" page here, indicating how many ressources we currently have available?|
|Overview:|          |          |          |
|	      |Cluster Overview|    |			This (except for the Hardware table) could be moved to the main landing site of the cluster.|
|          |Quick Reference|    |			Ok, even though I would move "Command line" and slurm examples to somewhere else (Apps/Shell?), and potentially rearrange a bit|
|          |Tutorials:|          |				Maybe rename into "How to use Triton" ? These are tutorials aimed at cluster usage, while many application pages are some kind of short tutorials on their use...
|          |Applications:|          |Should this be split into a "most commonly used apps" and a "Others" ?|
|          |          |Header   |			
|          |          |TL/DR	|This should contain both a workable approach for people who do not want to dig into details and people who have a general understanding of the matter. Optimally, this is a minimally commented box of commands to run to achieve the basic solution provided. Code (like slurm scripts) in this section is only provided in links, not explicitly written down.|
|          |          |Basic Usage |			The same example as in TL/DR but with more explanations.|
|          |		  |Advanced Usage (Optional)|			If there are more advanced ways to use a software, e.g. parameter settings etc pp, this and their explanation should go in here.|
|          |          |TroubleShooting (Optional)|			Known common issues should be refeenced here, either with pointers to Advanced/Basic usage or handled explicitly in this section.|
|          |          |Examples    |			Potential code examples not inc |
|          |Examples: |          |Should contain all stuff from the Application examples pages in condensed form....|
|          |Detailed Instructions:|          |Should either be moved to "Tutorials"/"How to use Triton" or to applications if applicable..|
|          |See also :|          |Can be removed (imo)
|RSEs      |          |          |Can stay as it is (maybe some updates)
|Scientific computing tips:|          |          |Can (imo) be either merged with Applications/Tutorials in Triton, or some of the tutorials be moved over here....
|Training:|          |          |Needs to be kept up to date, same as news.
					
## Other comments:					
### Things to merge/harmonize by imports:					
Python					
Data storage					
Remote access					
SSH					
					
					
### Things to update:					
Standalone Matlab indicates we still have MDCS, which we don't)					
CodeRefinery Page under Aalto Tools (or can be removed?)									
Many Application pages. Several need a relayouting, some need comprehensive updates, some might be removed?					
Also, is the list of applications complete?					
					
Can we advertise for a Student Job (someone to spend a week or so going through the docs, testing things etc pp) ? (I could try to do it if you let me know the normal advertisement process...					


## Simo

## Richard

- `/triton/apps/python` - main landing page on Python.  directs to ./conda for most work
- `/triton/apps/conda` - main landing page for conda, shows only our rocommended
- `/scicomp/conda` - deeper dive into conda, advnced things that come up sometime but people don't need to read often.  Advanced info copied from other pages.
- `/scicomp/jupyter-kernels` - details on jupyter kernel installation (focusing on cluster, since that's what is missing in general docs).  Most copied from 


