Readme to rst (#103)

* README to rst

* changelog

Author: mathause

Diff for: CHANGELOG.rst

@@ -32,7 +32,7 @@ Bug fixes
 - Reintroduce ability to read in cmip5 data from the cmip5-ng archive at ETH
   (`#90 <https://github.com/MESMER-group/mesmer/pull/90>`_).
   By `Lea Beusch <https://github.com/leabeusch>`_.
-   
+
 Internal Changes
 ^^^^^^^^^^^^^^^^
 - Reproduce the test files because of a change in regionmask which affected the mesmer
@@ -45,6 +45,10 @@ Internal Changes
 - The geopy package is no longer a dependency of mesmer
   (`#88 <https://github.com/MESMER-group/mesmer/pull/88>`_).
   By `Mathias Hauser <https://github.com/mathause>`_.
+- Convert README from Markdown to reStructuredText to fix package build errors. Also allows
+  to include the README in the docs to avoid duplication
+  (`#102 <https://github.com/MESMER-group/mesmer/issues/102>`_).
+  By `Mathias Hauser <https://github.com/mathause>`_.
 
 v0.8.1 - 2021-07-15
 -------------------

Diff for: README.md renamed to README.rst

@@ -1,43 +1,44 @@
-# MESMER
-
-**MESMER** is a **M**odular **E**arth **S**ystem **M**odel **E**mulator with
-spatially **R**esolved output, which stochastically creates Earth System
+MESMER: spatially resolved Earth System Model emulations
+--------------------------------------------------------
+**MESMER** is a **M**\ odular **E**\ arth **S**\ ystem **M**\ odel **E**\ mulator with
+spatially **R**\ esolved output, which stochastically creates Earth System
 Model-specific spatio-temporally correlated climate variable field realizations at a
 negligible computational cost.
 
 In combination with a global mean temperature emulator, MESMER can account for all three
 major sources of climate change projection uncertainty at the local scale: (i) internal
 variability uncertainty, i.e., unforced natural climate variability; (ii) forced climate
-response uncertainty, i.e., the Earth's system response to forced natural changes (solar
+response uncertainty, i.e., the Earth’s system response to forced natural changes (solar
 and volcanic) and human influences (greenhouse gas and aerosol emissions, land use
 changes etc.); and (iii) emission uncertainty, i.e., uncertainty in the emission pathway
 humans decide to follow. An interface between MESMER and global mean temperature
-emulators can be found at [MESMER-group/mesmer-openscmrunner](https://github.com/MESMER-group/mesmer-openscmrunner).
+emulators can be found at https://github.com/MESMER-group/mesmer-openscmrunner.
 
 MESMER is under active development both scientifically and technically. Future work will
 increase its user friendliness and extend its emulation capabilities to include
 additional emulation methods and target climate variables.
 
-
-##  Citing MESMER
+Citing MESMER
+-------------
 
 Scientific publications using MESMER should cite the following publication:
 
-Beusch, L., Gudmundsson, L., and Seneviratne, S. I.: Emulating Earth system model 
-temperatures with MESMER: from global mean temperature trajectories to grid-point-level 
-realizations on land, Earth Syst. Dynam., 11, 139–159, 
-https://doi.org/10.5194/esd-11-139-2020, 2020.
+  Beusch, L., Gudmundsson, L., and Seneviratne, S. I.: Emulating Earth system model
+  temperatures with MESMER: from global mean temperature trajectories to grid-point-level
+  realizations on land, Earth Syst. Dynam., 11, 139–159,
+  https://doi.org/10.5194/esd-11-139-2020, 2020.
 
-If MESMER is used to emulate multiple emission pathways and/or in combination with a 
+If MESMER is used to emulate multiple emission pathways and/or in combination with a
 global mean emulator, the following publication should additionally be cited:
 
-Beusch, L., Nicholls, Z., Gudmundsson, L., Hauser, M., Meinshausen M., and Seneviratne, 
-S. I.: From emission scenarios to spatially resolved projections with a chain of 
-computationally efficient emulators: MAGICC (v 7.5.1) - MESMER (v 0.8.1) coupling, 
-Geosci. Model Dev. Discuss. [preprint], https://doi.org/10.5194/gmd-2021-252, in review, 
-2021.
+  Beusch, L., Nicholls, Z., Gudmundsson, L., Hauser, M., Meinshausen M., and Seneviratne,
+  S. I.: From emission scenarios to spatially resolved projections with a chain of
+  computationally efficient emulators: MAGICC (v 7.5.1) - MESMER (v 0.8.1) coupling,
+  Geosci. Model Dev. Discuss. [preprint], https://doi.org/10.5194/gmd-2021-252, in review,
+  2021.
 
-## License
+License
+-------
 
 Copyright (c) 2021 ETH Zurich, MESMER contributors listed in AUTHORS.
 
@@ -53,4 +54,4 @@ You should have received a copy of the GNU General Public License along with MES
 not, see https://www.gnu.org/licenses/.
 
 The full list of code contributors can be found in AUTHORS or on
-[github.com/contributors](https://github.com/MESMER-group/mesmer/graphs/contributors).
+`github.com/contributors <https://github.com/MESMER-group/mesmer/graphs/contributors>`_

Diff for: docs/source/index.rst

@@ -25,51 +25,4 @@ Welcome to MESMER's documentation!
 
    changelog
 
-MESMER: spatially resolved Earth System Model emulations
---------------------------------------------------------
-**MESMER** is a **M**\ odular **E**\ arth **S**\ ystem **M**\ odel **E**\ mulator with
-spatially **R**\ esolved output, which stochastically creates Earth System
-Model-specific spatio-temporally correlated climate variable field realizations at a
-negligible computational cost.
-
-In combination with a global mean temperature emulator, MESMER can account for all three
-major sources of climate change projection uncertainty at the local scale: (i) internal
-variability uncertainty, i.e., unforced natural climate variability; (ii) forced climate
-response uncertainty, i.e., the Earth’s system response to forced natural changes (solar
-and volcanic) and human influences (greenhouse gas and aerosol emissions, land use
-changes etc.); and (iii) emission uncertainty, i.e., uncertainty in the emission pathway
-humans decide to follow. An interface between MESMER and global mean temperature
-emulators can be found at https://github.com/MESMER-group/mesmer-openscmrunner.
-
-MESMER is under active development both scientifically and technically. Future work will
-increase its user friendliness and extend its emulation capabilities to include
-additional emulation methods and target climate variables.
-
-Citing MESMER
--------------
-
-Scientific publications using MESMER should cite the following publication:
-
-Beusch, Lea, Lukas Gudmundsson, and Sonia I. Seneviratne, 2020: Emulating Earth system
-model temperatures with MESMER: from global mean temperature trajectories to
-grid-point-level realizations on land. Earth Syst. Dynam., 11, 139–159, 2020,
-https://doi.org/10.5194/esd-11-139-2020
-
-License
--------
-
-Copyright (c) 2021 ETH Zurich, MESMER contributors listed in AUTHORS.
-
-MESMER is free software; you can redistribute it and/or modify it under the terms of the
-GNU General Public License as published by the Free Software Foundation, version 3  or
-(at your option) any later version.
-
-MESMER is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-PURPOSE. See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with MESMER. If
-not, see https://www.gnu.org/licenses/.
-
-The full list of code contributors can be found in AUTHORS or on
-`github.com/contributors <https://github.com/MESMER-group/mesmer/graphs/contributors>`_
+.. include:: ../../README.rst

Diff for: setup.py

@@ -77,7 +77,7 @@
 PACKAGE_DATA = {}
 
 
-README = "README.md"
+README = "README.rst"
 
 with open(README, "r") as readme_file:
     README_TEXT = readme_file.read()