Skip to content

Commit

Permalink
Move page maintainers to top of page
Browse files Browse the repository at this point in the history
  • Loading branch information
bouweandela committed Nov 2, 2023
1 parent 268f780 commit c016d95
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 28 deletions.
6 changes: 3 additions & 3 deletions best_practices/language_guides/bash.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Bash

*Page maintainer: Bouwe Andela* [@bouweandela](https://github.com/bouweandela)


Bash is both a command line interface,
also known as a **shell**, and a scripting language.
On most Linux distributions, the Bash shell is the default way of interacting
Expand Down Expand Up @@ -200,6 +203,3 @@ set -e
- [Bash Cheat sheet](https://devhints.io/bash)
- The [Bash Reference Manual](https://www.gnu.org/savannah-checkouts/gnu/bash/manual/bash.html) or use `man bash`
- [Oh My Zsh](https://ohmyz.sh/) offers an extensive set of themes and shortcuts for the Zsh


*Page maintainer: Bouwe Andela* [@bouweandela](https://github.com/bouweandela)
6 changes: 3 additions & 3 deletions best_practices/language_guides/ccpp.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# C and C++

*Page maintainers: Johan Hidding* [@jhidding](https://github.com/jhidding) *and Patrick Bos* [@egpbos](https://github.com/egpbos)


C++ is one of the hardest languages to learn. Entering a project where C++ coding is needed should not be taken lightly. This guide focusses on tools and documentation for use of C++ in an open-source environment.

### Standards
Expand Down Expand Up @@ -325,6 +328,3 @@ A newer but less mature option is [cldoc](http://jessevdk.github.io/cldoc/).
### Books
* Bjarne Soustrup - The C++ Language
* Scott Meyers - Effective Modern C++


*Page maintainers: Johan Hidding* [@jhidding](https://github.com/jhidding) *and Patrick Bos* [@egpbos](https://github.com/egpbos)
6 changes: 3 additions & 3 deletions best_practices/language_guides/fortran.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Fortran

*Page maintainer: Gijs van den Oord* [@goord](https://github.com/goord)


**Disclaimer: In general the Netherlands eScience Center does not recommend using Fortran. However, in some cases it is the only viable option, for instance if a project builds upon existing code written in this language. This section will be restricted to Fortran90, which captures majority of Fortran source code.**

The second use case may be extremely performance-critical dense
Expand Down Expand Up @@ -40,6 +43,3 @@ standard conventions, described in the [official documentation](http://www.fortr
* Add concise comments to modules and routines, and add comments to less obvious lines of code.
* Provide a test suite with your code, containing both unit and integration tests. Both automake and cmake provide test
suite functionality; if you create your makefile yourself, add a separate testing target.


*Page maintainer: Gijs van den Oord* [@goord](https://github.com/goord)
6 changes: 3 additions & 3 deletions best_practices/language_guides/javascript.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Getting started

*Page maintainer: Jurriaan Spaaks* [@jspaaks](https://github.com/jspaaks)


To learn about JavaScript, view the presentations by [Douglas Crockford](http://en.wikipedia.org/wiki/Douglas_crockford):

* [Crockford on JavaScript](http://www.youtube.com/playlist?list=PL7664379246A246CB)
Expand Down Expand Up @@ -230,6 +233,3 @@ Alternative could be [TSdoc](https://www.npmjs.com/package/tsdoc)
[TSLint](https://github.com/palantir/tslint) is a good tool to check your codestyle.

For the [sim-city-cs project](https://github.com/indodutch/sim-city-cs/) we use [this](https://github.com/ReGIS-org/regis/blob/develop/tslint.json) tslint.json file.


*Page maintainer: Jurriaan Spaaks* [@jspaaks](https://github.com/jspaaks)
7 changes: 4 additions & 3 deletions best_practices/language_guides/languages_overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

*Page maintainer: unmaintained*


This chapter provides practical info on each of the main programming languages of the Netherlands eScience Center.

This info is (on purpose) high level, try to provide "default" options, and mostly link to more info.
Expand Down Expand Up @@ -44,6 +48,3 @@ Highly recommented to get some inspiration on available tools and libraries!
To do development in any language you first need infrastructure (code hosting, ci, etc). Luckily a lot is available for free now.

See this list: https://github.com/ripienaar/free-for-dev


*Page maintainer: unmaintained*
5 changes: 2 additions & 3 deletions best_practices/language_guides/opencl_cuda.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# OpenCL & CUDA

*Page maintainer: Alessio Sclocco* [@isazi](https://github.com/isazi)


## Sources for learning
*please add university courses and informative videos*
Expand Down Expand Up @@ -65,6 +67,3 @@
* Generic Auto Tuners:
* [Kernel Tuner](https://github.com/benvanwerkhoven/kernel_tuner) (Python)
* [CLTune](https://github.com/CNugteren/CLTune) (C++)


*Page maintainer: unmaintained*
6 changes: 3 additions & 3 deletions best_practices/language_guides/python.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Python

*Page maintainer: Patrick Bos* [@egpbos](https://github.com/egpbos)


Python is the "dynamic language of choice" of the Netherlands eScience Center.
We use it for data analysis and data science projects using the SciPy stack and Jupyter notebooks, and for [many other types of projects](https://github.com/NLeSC?language=python): workflow management, visualization, NLP, web-based tools and much more.
It is a good default choice for many kinds of projects due to its generic nature, its large and broad ecosystem of third-party modules and its compact syntax which allows for rapid prototyping.
Expand Down Expand Up @@ -325,6 +328,3 @@ We recommend `flask`.
* For run-time configuration via command-line options, the built-in [`argparse`](https://docs.python.org/library/argparse.html) module usually suffices.
* A more complete solution is [`ConfigArgParse`](https://github.com/bw2/ConfigArgParse). This (almost) drop-in replacement for `argparse` allows you to not only specify configuration options via command-line options, but also via (ini or yaml) configuration files and via environment variables.
* Other popular libraries are [`click`](https://click.palletsprojects.com) and [`fire`](https://google.github.io/python-fire/).


*Page maintainer: Patrick Bos* [@egpbos](https://github.com/egpbos)
7 changes: 4 additions & 3 deletions best_practices/language_guides/r.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# What is R?

*Page maintainer: unmaintained*


R is a functional programming language and software environment for statistical computing and graphics: https://www.r-project.org/.

## Philosophy and typical use cases
Expand Down Expand Up @@ -131,6 +135,3 @@ Debugging is possible in RStudio, see [link](https://support.rstudio.com/hc/en-u

# Not in this tutorial yet:
* Logging


*Page maintainer: unmaintained*
7 changes: 3 additions & 4 deletions best_practices/user_experience.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@

# User Experience (UX)

*Page maintainer: Jesus Garcia* [@ctwhome](https://github.com/ctwhome)


User Experience Design (UX) is a broad, holistic science that combines many cognitive and brain sciences disciplines like psychology and sociology, content strategies, and arts and aesthetics by following human-center approaches.

> Human-centred design is an approach to interactive systems development that aims to make systems usable and useful by focusing on the users, their needs and requirements, and applying human factors/ergonomics and usability knowledge and techniques. This approach enhances effectiveness and efficiency, improves human well-being, user satisfaction, accessibility, sustainability, and counteracts possible adverse effects on human health, safety, and performance. [HCDSociety](https://human-centered-design.org/about/)
Expand Down Expand Up @@ -67,6 +69,3 @@ Design tools used for Visual Design, Prototyping, and IxD testing collaborative,
* [Figma](https://www.figma.com/)
* [Miro](https://miro.com/)
* [Whimsical](https://whimsical.com/)


*Page maintainer: Jesus Garcia* [@ctwhome](https://github.com/ctwhome)

0 comments on commit c016d95

Please sign in to comment.