Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.27 KB

STYLE_GUIDE.md

File metadata and controls

67 lines (47 loc) · 2.27 KB
Raw

Style Guide for MDAnalysis

Name

When referring to the project we always capitalize as

  • ✔️ MDAnalysis

and not

  • ✖️ MDanalysis
  • ✖️ Mdanalysis
  • ✖️ mdanalysis
  • ✖️ MDANALYSIS

In logo art we may break the name as

MD
Analysis

MDAnalysis is a proper noun when we refer to the project/organization or the library itself so it is typeset in the standard typeface of the surrounding text. It is not set in monospace typeface. It may be set in italics (MDAnalysis) or another common style (e.g., sans serif) to visually distinguish software names.

  • ✔️ MDAnalysis
  • ✔️ MDAnalysis
  • ✖️ MDAnalysis
  • ✔️ "The MDAnalysis library is one of the most used Python-based packages for the analysis of molecular dynamics simulations."

If we refer to the importable Python package of the MDAnalysis library or if we write code then we do typeset in monospace (if available):

  • ✔️ "Most scripts start with import MDAnalysis as mda."
  • ✔️ "Importing the MDAnalysis package is a form of linking as far as the GPL is concerned."
  • ✖️ "When loading the MDAnalysis package you can alias it to the short form mda."

Colors

Logo Colors

  • black #000000 (RGB 000000)
  • gray #808080 (RGB 808080)
  • orange #FF9200 (RGB FF9200)

Web site colors

MDAnalysis theme

  • MDAnalysis orange: #FF9200
  • MDAnalysis gray: #808080
  • RTD dark gray: #343131 (from User Guide RTD dark gray)
  • RTD light grey: #E6E6E6
  • MDAnalysis black: #000000
  • MDAnalysis white: #FFFFFF

Documentation colors

  • MDAnalysis orange: #FF9200
  • MDAnalysis gray: #808080
  • MDAnalysis white: #FFFFFF
  • MDAnalysis black: #000000
  • Very light orange: #FFEBD0
  • Code orange: #ca6500
  • RTD dark grey: #343131
  • RTD light grey: #e6e6e6

The User Guide CSS theme has some others for coloured elements, where we needed to differentiate between notes, warnings, etc. -- they have some pastel red/orange/yellows (backgrounds) and darker red/orange/yellows (text).

Typefaces