Skip to content

Commit cf90425

Browse files
Web interfaces as systems (#1690)
* Add web interfaces as systems * Define availability in front matter * Replace spaces with dashes in link anchor * Remove repeated 'Available on' * Revert "Define availability in front matter" This reverts commit 0aa5ecb. * Reorder systems * List web interfaces separately Additionally, some refactoring * Available in Puhti and Mahti web interfaces * Update page and make it a SectionPage for 'Interactive apps' * More apps for web interfaces * Fix outdated information * Documentation on web interface tags * Fixed heading Newline to end of file * Revert "Available in Puhti and Mahti web interfaces" This reverts commit 0054436. * Partially revert "More apps for web interfaces" This partially reverts commit a82140e. * Adjust punctuation and whitespace for consistency * Added interactive applications * Alphabetization * Remove accidental whitespace * Note to instructions about pull request not updating --------- Co-authored-by: Ari-Matti Saren <ari-matti.saren@csc.fi>
1 parent ea38f8f commit cf90425

18 files changed

+385
-35
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ must use pull requests.
5656
- Please add a link to the rahtiapp-preview page `https://csc-guide-preview.rahtiapp.fi/origin/<your-branch-name>/rest-of-url/`) in the Pull Request description to help reviewer.
5757
- You can also add a label to your PR. For example, if your edit is minor (e.g. fixed link or typo), you can add the label "trivial change" to expedite the reviewing process.
5858
- Pull requests which do not meet the requirements will not be accepted. Note that you can keep committing to a pull request after it has been submitted.
59+
- If your commits aren't showing up on the pull request, i.e., the pull request isn't updating when making new commits, try switching the base branch ('Edit' button, top-right) from `master` to something else and then back again.
5960
- Write meaningful pull request messages, so it is easier for reviewers to do their job.
6061
- Communicate! Use "WIP" (= Work In Progress) in your pull request title, if you don't wish the branch to be merged to master (i.e. you want to continue working with it).
6162
- Once your PR has been accepted, remove the temporary branch (if not deleted by an admin at merge)

FAQ.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The [contributing guide](CONTRIBUTING.md) outlines the basic steps of starting c
2323
- [How do I add definitions to the glossary / display definitions as tooltips?](#how-do-i-add-definitions-to-the-glossary--display-definitions-as-tooltips)
2424
- [How do I use the announcement bar?](#how-do-i-use-the-announcement-bar)
2525
- [How do I add a license tag to an application page?](#how-do-I-add-a-license-tag-to-an-application-page)
26+
- [How do I tag an application as available under a web interface?](#how-do-i-tag-an-application-as-available-under-a-web-interface)
2627
- [How do I make footnotes?](#how-do-i-make-footnotes)
2728
- [How do I improve search results?](#how-do-i-improve-search-results)
2829

@@ -296,6 +297,38 @@ where `<license>` is one of the predefined license categories: `Academic`, `Free
296297

297298
The application will then be included on the Applications by license page automatically.
298299

300+
## How do I tag an application as available under a web interface?
301+
302+
As with [adding a license tag](#how-do-I-add-a-license-tag-to-an-application-page), an application
303+
can be tagged as available in a particular web interface. The application will then be listed under
304+
that web interface on the _Applications by availability_ page. The tags for web interfaces that an
305+
application is available on are added under the `system` key in the front matter.
306+
307+
```yaml
308+
---
309+
system:
310+
- www-<system1>
311+
- www-<system2>
312+
---
313+
```
314+
315+
where `<system1>` or `<system2>` is one of the systems where a web interface is available, for
316+
example (prefixed with `www-`) `mahti` or `puhti`.
317+
318+
As a temporary workaround, to prevent an application getting listed under a system for merely
319+
mentioning the system, edit the [skip_system.txt](scripts/skip_system.txt) file.
320+
321+
```text
322+
Workaround:
323+
324+
...
325+
326+
SKIP_<system1> application.md
327+
SKIP_<system2> application.md
328+
```
329+
330+
where `<system1>` and `<system2>` are as above.
331+
299332
## How do I add footnotes?
300333

301334
Usage of the footnotes feature is described
@@ -314,4 +347,4 @@ search:
314347
...
315348
```
316349
Start with low values.
317-
More information [here](https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#rank-up)
350+
More information [here](https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#rank-up)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
tags:
3+
- Free
4+
system:
5+
- www-puhti
6+
---
7+
8+
# Accelerated visualization
9+
10+
A selection of GPU accelerated visualization applications.
11+
12+
13+
## License
14+
15+
Free
16+
17+
18+
## Available
19+
20+
Accelerated visualization is available as an interactive application via the Puhti web interface.
21+
22+
23+
## More information
24+
25+
More information on Accelerated visualization, interactive applications, and the web interfaces can be found under the [Computing section](../computing/index.md):
26+
27+
- [Accelerated visualization](../computing/webinterface/accelerated-visualization.md)
28+
- [Interactive applications](../computing/webinterface/apps.md)
29+
- [Web interfaces](../computing/webinterface/index.md)

docs/apps/by_discipline.md

Lines changed: 35 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,27 @@
33
!!! Note
44
In addition to technical support, CSC also provides expert consulting in questions related to sciences and methods. For more details, see our [science-specific support pages at research.csc.fi](https://research.csc.fi/sciences) or directly [contact our Service Desk](../support/contact.md).
55

6+
67
## Biosciences
78

89
* [BAMtools](bamtools.md) Tools for working with BAM formatted files
9-
* [BayeScan](bayescan.md) Tool for identifying candidate loci under natural selection based on allele frequencies in populations.
10+
* [BayeScan](bayescan.md) Tool for identifying candidate loci under natural selection based on allele frequencies in populations
1011
* [Bioconda](bioconda.md) Package manger for installing bioinformatics software
1112
* [BioPerl](bioperl.md) Perl environment with bioperl extension
1213
* [BioPython](biopython.md) Python environment with biopython and other bioinformatics related Python libraries
1314
* [BLAST](blast.md) Sequence similarity search tool for nucleotides and proteins
14-
* [Bowtie2](bowtie2.md) Short read aligner
15+
* [Bowtie2](bowtie2.md) Short read aligner
1516
* [BRAKER](braker.md) Automatic genome annotator for eucaryots
1617
* [BWA](bwa.md) Short read aligner
1718
* [CD-hit](cd-hit.md) Sequence clustering and redundancy removal tool
1819
* [Chipster](https://chipster.csc.fi/) Easy-to-use analysis platform for RNA-seq, single cell RNA-seq and other NGS data
1920
* [Chipster_genomes](chipster_genomes.md) Tool to download aligner indexes used by Chipster to Puhti
2021
* [Cutadapt](cutadapt.md) Trimming high-throughput sequencing reads
2122
* [Diamond](diamond.md ) Sequence similarity search tool for proteins and nucloeotides
22-
* [Discovery Studio](discovery-studio.md) Protein modeling environment.
23+
* [Discovery Studio](discovery-studio.md) Protein modeling environment
2324
* [Edirect](edirect.md) Entrez direct - command line tool to search and retrieve data from NCBI
2425
* [EMBOSS](emboss.md) Toolkit for classical sequence analysis
25-
* [Exonerate](exonerate.md) A generic tool for pairwise sequence comparison.
26+
* [Exonerate](exonerate.md) A generic tool for pairwise sequence comparison
2627
* [FastQC](fastqc.md) Quality control tool for high throughput sequence data
2728
* [Freebayes](freebayes.md) Genetic variant detector
2829
* [GOLD](gold.md) Protein Ligand Docking Software
@@ -43,7 +44,7 @@
4344
* [Megahit](megahit.md) Metagenomics assembly
4445
* [MetaPhlAn](metaphlan.md) Profiling the composition of microbial communities with metagenomic data
4546
* [Minimap2](minimap2.md) Short read aligner
46-
* [Mothur](mothur.md) Package for microbial community analysis of amplicon sequencing data
47+
* [Mothur](mothur.md) Package for microbial community analysis of amplicon sequencing data
4748
* [MrBayes](mrbayes.md) Program for inferring phylogenies using Bayesian methods
4849
* [Pannzer](pannzer.md) Automatic protein annotation tool
4950
* [Picard](picard.md) Tools for working with SAM,BAM,CRAM and VCF files
@@ -62,15 +63,16 @@
6263
* [Trinity](trinity.md) Traskriptome assembly tool
6364
* [Velvet](velvet.md) Genome assembler
6465
* [VirusDetect](virusdetect.md) Virus identification with sRNA data
65-
* [VMD](vmd.md) Molecular visualization program
66+
* [VMD](vmd.md) Molecular visualization program
6667
* [wtdbg2](wtdbg2.md) Fast assembler for long-read data
6768
* [XHMM](xhmm.md) Copy number variation calling from targeted sequencing data
6869

70+
6971
## Chemistry
7072

7173
* [Amber](amber.md) Molecular dynamics suite
7274
* [AMS](ams.md) Modelling suite providing engines like ADF, BAND, DFTB and MOPAC
73-
* [AMS-GUI](ams-gui.md) AMS integrated GUI
75+
* [AMS-GUI](ams-gui.md) AMS integrated GUI
7476
* [CP2k](cp2k.md) DFT, quantum chemistry, QM/MM, AIMD etc. in particular for periodic systems
7577
* [CSD](csd.md) Cambridge Crystallographic Database - organic and metallo-organic crystal structures and tools
7678
* [Gaussian](gaussian.md) Versatile computational chemistry package
@@ -83,14 +85,15 @@
8385
* [MOLDEN](molden.md) Processing program for molecular and electronic structure calculations
8486
* [MOLPRO](molpro.md) Package for accurate ab initio quantum chemistry calculations
8587
* [NAMD](namd.md) Highly scalable classical molecular dynamics
86-
* [NWChem](nwchem.md) A computational chemistry software package designed to perform well on parallel HPC systems.
88+
* [NWChem](nwchem.md) A computational chemistry software package designed to perform well on parallel HPC systems
8789
* [Open Babel](openbabel.md) Program to interconvert file formats currently used in molecular modeling
8890
* [ORCA](orca.md) General purpose quantum chemistry package
8991
* [Plumed](plumed.md) Library and tools for enhanced sampling methods
9092
* [TmoleX](tmolex.md) GUI for setting up and analyzing TURBOMOLE jobs
9193
* [Turbomole](turbomole.md) Efficient program package for electronic structure calculations
9294
* [VASP](vasp.md) Ab initio DFT electronic structures
93-
* [VMD](vmd.md) Molecular visualization program
95+
* [VMD](vmd.md) Molecular visualization program
96+
9497

9598
## Computational Engineering
9699

@@ -102,15 +105,17 @@
102105
* [PALM](palm.md) Meteorological model system for atmospheric and oceanic boundary-layer flows
103106
* [Star-CCM+](starccm+.md) Computational Fluid Dynamics software by Siemens Digital Industries Software
104107

108+
105109
## Data Analytics and Machine Learning
106110

111+
* [JAX](jax.md) Autograd and XLA, brought together for high-performance machine learning
107112
* [Python Data](python-data.md) Collection of Python libraries for data analytics and machine learning
108-
* [JAX](jax.md) Autograd and XLA, brought together for high-performance machine learning
109113
* [PyTorch](pytorch.md) Machine learning framework for Python
110114
* [RAPIDS](rapids.md) Suite of libraries for data analytics and machine learning on GPUs
111-
* [Spark](spark.md) High-performance distributed computing framework
115+
* [Spark](spark.md) High-performance distributed computing framework
112116
* [TensorFlow](tensorflow.md) Deep learning library for Python
113117

118+
114119
## Geosciences
115120

116121
* [Ames Stereo Pipeline](ames-stereo.md) for processing stereo images
@@ -131,39 +136,50 @@
131136
* [Sen2Cor](sen2cor.md) for atmospheric-, terrain and cirrus correction of the Sentinel-2 products
132137
* [Sen2mosaic](sen2mosaic.md) for download, preprocessing and mosaicing of Sentinel-2 products
133138
* [SNAP](snap.md) for remote sensing applications
134-
* [WhiteboxTools](whiteboxtools.md) an advanced geospatial data analysis platform
135-
* [Zonation](zonation.md) Spatial conservation prioritization framework
139+
* [WhiteboxTools](whiteboxtools.md) an advanced geospatial data analysis platform
140+
* [Zonation](zonation.md) Spatial conservation prioritization framework
141+
136142

137143
## Language Research and Other Digital Humanities and Social Sciences
138144

139145
* [eBay's tsv-tools](http://urn.fi/urn:nbn:fi:lb-202006081) Utilities for manipulating large tabular data files
140-
* [finnish-parse](http://urn.fi/urn:nbn:fi:lb-2017030801) Dependency Parser for Finnish
141146
* [Finnish Tagtools](http://urn.fi/urn:nbn:fi:lb-201908161) Finnish Tagtools
147+
* [finnish-parse](http://urn.fi/urn:nbn:fi:lb-2017030801) Dependency Parser for Finnish
142148
* [HFST](http://urn.fi/urn:nbn:fi:lb-20140730183) Helsinki Finite-State Transducer Technology
143149
* [HFST-fi](http://urn.fi/urn:nbn:fi:lb-201509034) Helsinki Finite-State Technology for Finnish
144150
* [HFST-sv](http://urn.fi/urn:nbn:fi:lb-201509035) Helsinki Finite-State Technology for Swedish
145151
* [Kaldi](http://urn.fi/urn:nbn:fi:lb-2019121020) Kaldi Speech Recognition Toolkit
146152
* [UDPipe](http://urn.fi/urn:nbn:fi:lb-201902131) UDPipe Kielipankki version
147153

154+
148155
## Mathematics and Statistics
149156

150157
* [IDL](idl.md) Programming Language, Numeric Analysis, Manipulation and Visualization of Scientific Data
151158
* [Julia](julia.md) High-level, high-performance dynamic programming language for numerical computing
152159
* [MATLAB](matlab.md) High-level technical computing language
153-
* [Octave](octave.md) High-level interpreted language for numerical computations.
154-
* [Python](python.md) programming language and its modules at CSC.
160+
* [Octave](octave.md) High-level interpreted language for numerical computations
161+
* [Python](python.md) programming language and its modules at CSC
155162
* [r-env](r-env.md) R, RStudio Server, SAGA and TensorFlow
156163
* [RStudio](rstudio.md) Integrated development environment for R
157164
* [SageMath](sagemath.md) Free open-source mathematics software system
158165

166+
159167
## Physics
160168

161169
* [VASP](vasp.md) Ab initio DFT electronic structures
162170

171+
163172
## Miscellaneous
164173

165-
* [DDT](ddt.md) Parallel debugger
166-
* [MySQL](../data/kaivos/overview.md) MySQL database client.
174+
* [Accelerated visualization](accelerated-visualization.md) A selection of GPU accelerated visualization applications
175+
* [DDT](ddt.md) Parallel debugger
176+
* [Desktop](desktop.md) Remote desktop environment
177+
* [HyperQueue](hyperqueue.md) Scheduler for sub-node tasks
178+
* [Julia-Jupyter](julia-jupyter.md) Interactive computational environment with Julia
179+
* [Jupyter](jupyter.md) Interactive computational environment with Python
180+
* [Jupyter for courses](jupyter-for-courses.md) A version of the Jupyter app for course environments
181+
* [MySQL](../data/kaivos/overview.md) MySQL database client.
167182
* [ParaView](paraview.md) Free open-source visualization application
183+
* [TensorBoard](tensorboard.md) The visualization toolkit for TensorFlow
168184
* [VisIt](visit.md) Free open-source visualization application
169-
* [HyperQueue](hyperqueue.md) Scheduler for sub-node tasks
185+
* [Visual Studio Code](vscode.md) Source code editor

docs/apps/by_system.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,7 @@ These headings are needed by the tests:
1111
## Puhti
1212

1313
## LUMI
14+
15+
## Mahti web interface
16+
17+
## Puhti web interface

docs/apps/desktop.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
tags:
3+
- Free
4+
system:
5+
- www-mahti
6+
- www-puhti
7+
---
8+
9+
# Desktop
10+
11+
Access a remote Xfce desktop environment on a supercomputer.
12+
13+
14+
## License
15+
16+
Free
17+
18+
19+
## Available
20+
21+
Desktop is available as an interactive application via the web interface for
22+
23+
- Mahti
24+
- Puhti
25+
26+
27+
## More information
28+
29+
More information on Desktop, interactive applications, and the web interfaces can be found under the [Computing section](../computing/index.md):
30+
31+
- [Desktop](../computing/webinterface/desktop.md)
32+
- [Interactive applications](../computing/webinterface/apps.md)
33+
- [Web interfaces](../computing/webinterface/index.md)

docs/apps/julia-jupyter.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
tags:
3+
- Free
4+
system:
5+
- www-mahti
6+
- www-puhti
7+
---
8+
9+
# Julia-Jupyter
10+
11+
A version of the [Jupyter app](jupyter.md) for Julia programming language.
12+
13+
14+
## License
15+
16+
Free
17+
18+
19+
## Available
20+
21+
Julia-Jupyter is available as an interactive application via the web interface for
22+
23+
- Mahti
24+
- Puhti
25+
26+
27+
## More information
28+
29+
More information on Julia-Jupyter, interactive applications, and the web interfaces can be found under the [Computing section](../computing/index.md):
30+
31+
- [Julia-Jupyter](../computing/webinterface/julia-on-jupyter.md)
32+
- [Interactive applications](../computing/webinterface/apps.md)
33+
- [Web interfaces](../computing/webinterface/index.md)

docs/apps/jupyter-for-courses.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
tags:
3+
- Free
4+
system:
5+
- www-mahti
6+
- www-puhti
7+
---
8+
9+
# Jupyter for courses
10+
11+
A version of the [Jupyter app](jupyter.md) for setting up custom course environments.
12+
13+
14+
## License
15+
16+
Free
17+
18+
19+
## Available
20+
21+
Jupyter for courses is available as an interactive application via the web interface for
22+
23+
- Mahti
24+
- Puhti
25+
26+
27+
## More information
28+
29+
More information on Jupyter for courses, interactive applications, and the web interfaces for courses can be found under the [Computing section](../computing/index.md):
30+
31+
- [Jupyter for courses](../computing/webinterface/jupyter-for-courses.md)
32+
- [Interactive applications](../computing/webinterface/apps.md)
33+
- [Web interfaces](../computing/webinterface/index.md)

docs/apps/jupyter.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
tags:
3+
- Free
4+
system:
5+
- www-mahti
6+
- www-puhti
7+
---
8+
9+
# Jupyter
10+
11+
Web-based interactive computational environment for Python programming language.
12+
13+
14+
## License
15+
16+
Free
17+
18+
19+
## Available
20+
21+
Jupyter is available as an interactive application via the web interface for
22+
23+
- Mahti
24+
- Puhti
25+
26+
27+
## More information
28+
29+
More information on Jupyter, interactive applications, and the web interfaces can be found under the [Computing section](../computing/index.md):
30+
31+
- [Jupyter](../computing/webinterface/jupyter.md)
32+
- [Interactive applications](../computing/webinterface/apps.md)
33+
- [Web interfaces](../computing/webinterface/index.md)

0 commit comments

Comments
 (0)