From 009ec225f0408f4e4f1366bec2c5576b61c88160 Mon Sep 17 00:00:00 2001 From: Richard Gowers Date: Wed, 5 Feb 2020 23:58:29 +0000 Subject: [PATCH] add NumFOCUS sponsorship (issue #2460) (#2467) * close #2460 * close #2506 * Add NumFOCUS sponsorship text with affiliation and donation links (donation link from #2506) * use rst syntax (based on official template https://github.com/numfocus/templates/blob/master/fiscal-sponsor-readme-attribution.md) * add link to Code of Conduct (as in template) * updated high level description * add NumFOCUS audit anchor as a reST link target as suggested by @jbarnoud * create GOVERNANCE.md (This file is required as a NumFOCUS sponsored project. Our primary governance document is https://www.mdanalysis.org/about/#governance) Co-authored-by: Max Linke Co-authored-by: Oliver Beckstein --- GOVERNANCE.md | 13 +++++++++++++ README.rst | 42 ++++++++++++++++++++++++++++++++++-------- 2 files changed, 47 insertions(+), 8 deletions(-) create mode 100644 GOVERNANCE.md diff --git a/GOVERNANCE.md b/GOVERNANCE.md new file mode 100644 index 00000000000..6c716aeae2f --- /dev/null +++ b/GOVERNANCE.md @@ -0,0 +1,13 @@ +# Governance of MDAnalysis + +Please see [About MDAnalysis: Governance](https://www.mdanalysis.org/about/#governance) for the description of how decisions are made for the MDAnalysis project. + +Below is a summary of the governance model (but note that if the text on this page and the page [About MDAnalysis: Governance](https://www.mdanalysis.org/about/#governance) disagree then the [About MDAnalysis: Governance](https://www.mdanalysis.org/about/#governance) page takes precedence): + +---- + +Project leadership is provided by a subset of contributors, the **MDAnalysis Core Developers** ([@MDAnalysis/coredevs](https://github.com/orgs/MDAnalysis/teams/coredevs)) who have produced substantial contributions over extended lengths of time and who remain active in reviewing issues and discussions on the various mailing lists. MDAnalysis Core Developers are granted commit rights (write access) to the GitHub source code repository. New MDAnalysis Core Developers are elected with a simple majority of current MDAnalysis Core Developers. + +All decisions are made by simple majority of the MDAnalysis Core Developers. + +A rotating subset of three MDAnalysis Core Developers is tasked to respond to and to investigate [Code of Conduct](https://www.mdanalysis.org/pages/conduct/) violations. diff --git a/README.rst b/README.rst index 5644547c538..6bbeb01bd5e 100644 --- a/README.rst +++ b/README.rst @@ -2,15 +2,31 @@ MDAnalysis Repository README ================================ -|build| |cov| [*]_ +|numfocus| |build| |cov| [*]_ |docs| |devdocs| |usergroup| |developergroup| |anaconda| |mybinder| +MDAnalysis_ is a Python library for the analysis of computer simulations of many-body systems at the molecular scale, spanning use cases from interactions of drugs with proteins to novel materials. It is widely used in the scientific community and is written by scientists for scientists. -MDAnalysis_ is a Python toolkit to analyze molecular dynamics -trajectories generated by a wide range of popular simulation packages -including DL_Poly, CHARMM, Amber, NAMD, LAMMPS, and Gromacs. (See the -lists of supported `trajectory formats`_ and `topology formats`_.) +It works with a a wide range of popular simulation packages including Gromacs, Amber, NAMD, CHARMM, DL_Poly, HooMD, LAMMPS and many other — see the lists of supported `trajectory formats`_ and `topology formats`_. +MDAnalysis also includes widely used analysis algorithms in the `MDAnalysis.analysis`_ module. + +.. _numfocus-fiscal-sponsor-attribution: + +The MDAnalysis project uses an `open governance model` and is fiscally sponsored by `NumFOCUS`_. Consider making +a `tax-deductible donation`_ to help the project pay for developer time, professional services, travel, workshops, and a variety of other needs. + +.. image:: https://raw.githubusercontent.com/numfocus/templates/master/images/numfocus-logo.png + :height: 60px + :target: https://numfocus.org/project/mdanalysis + :align: center + :alt: NumFOCUS + +This project is bound by a `Code of Conduct`_. + + +Example analysis script +======================= .. code:: python @@ -30,9 +46,9 @@ lists of supported `trajectory formats`_ and `topology formats`_.) # Iterate through trajectories for ts in u.trajectory: print(ag.center_of_mass()) - -There are also a number of tutorials_ on the MDAnalysis homepage that explain -how to conduct RMSD calculations, Alignment and more features of MDAnalysis. + +There are a number of tutorials_ on the MDAnalysis homepage that explain +how to conduct RMSD calculations, Alignment and many more features of MDAnalysis. Source code =========== @@ -70,11 +86,17 @@ guide_. If you are a new developer who would like to start contributing to MDAnalysis as a start you can increase our code coverage, the guides explain how to find uncovered code. + + .. Footnotes .. [*] **build**: Unit testing is for the whole package; **coverage** is shown for the core library modules and the analysis modules. +.. _NumFOCUS: https://numfocus.org/ +.. _open governance model: https://www.mdanalysis.org/about/#governance +.. _tax-deductible donation: https://numfocus.salsalabs.org/supportmdanalysis +.. _`Code of Conduct`: https://www.mdanalysis.org/pages/conduct/ .. _trajectory formats: https://docs.mdanalysis.org/documentation_pages/coordinates/init.html#id1 .. _topology formats: https://docs.mdanalysis.org/documentation_pages/topology/init.html#supported-topology-formats .. _Issue 87: https://github.com/MDAnalysis/mdanalysis/issues/87 @@ -101,6 +123,10 @@ to find uncovered code. :alt: Documentation (development version) :target: https://www.mdanalysis.org/mdanalysis/ +.. |numfocus| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A + :alt: Powered by NumFOCUS + :target: https://www.numfocus.org/ + .. |build| image:: https://travis-ci.com/MDAnalysis/mdanalysis.svg?branch=develop :alt: Build Status :target: https://travis-ci.com/MDAnalysis/mdanalysis