Release v1.0

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://www.travis-ci.org/maahn/pyOptimalEstimation.svg?branch=master)](https://www.travis-ci.org/maahn/pyOptimalEstimation)
 [![Coverage Status](https://coveralls.io/repos/github/maahn/pyOptimalEstimation/badge.svg?branch=master)](https://coveralls.io/github/maahn/pyOptimalEstimation?branch=master)
 
-# "pyOptimalEstimation" Package
+# "pyOptimalEstimation" Package v1.0
 
 Python package to solve an inverse problem using Optimal Estimation
 and an arbitrary Forward model following Rodgers, 2000.
@@ -18,19 +18,19 @@ in the terminal. If you do not have root privileges, you can also do:
 ```
   python setup.py --user install
 ```
-which will install pyOptimalEstimation in userbase/lib/pythonX.Y/site-packages
+which will install pyOptimalEstimation in `userbase/lib/pythonX.Y/site-packages`
 or
 ```
   python setup.py install --home=~
 ```
-which will install pyOptimalEstimation in ~/lib/python.
-
-## Manual
-
-See https://pyoptimalestimation.readthedocs.io/en/latest/ for documentation.
+which will install pyOptimalEstimation in `~/lib/python`.
 
 ## Examples
 
 Annotated example applications are available at https://github.com/maahn/pyOptimalEstimation_examples.
 
+## API documentation
+
+See https://pyoptimalestimation.readthedocs.io/en/latest/ for documentation.
+
 

docs/index.rst

@@ -14,8 +14,15 @@ Download
 
 The code is available at https://github.com/maahn/pyOptimalEstimation
 
+Examples
+--------
+
+Please see pyOptimalEstimation/examples for a minimal working example. For more extensive examples, check out  https://github.com/maahn/pyOptimalEstimation_examples
+
+
 Installation
 ------------
+Make sure you use Python 2.7, 3.6 or newer.
 
 Change to the folder containing the project and do ::
 
@@ -32,13 +39,8 @@ which will install pyOptimalEstimation in userbase/lib/pythonX.Y/site-packages o
 which will install pyOptimalEstimation in ~/lib/python.
 
 
-Example
--------
-Please see pyOptimalEstimation/examples for a minimal working example.
-
-
-:mod:`pyOEcore` Module
-----------------------
+API documentation
+-----------------
 
 .. automodule:: pyOptimalEstimation.pyOEcore
     :members:

pyOptimalEstimation/pyOEcore.py

@@ -6,19 +6,6 @@
 maximilian.maahn@colorado.edu
 https://github.com/maahn/pyOptimalEstimation
 
-This program 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, either version 3 of the License, or
-any later version.
-
-This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
-
 '''
 
 from __future__ import absolute_import

setup.py

@@ -32,13 +32,13 @@
 if __name__ == "__main__":
     setup(
         name='pyOptimalEstimation',
-        version='0.2dev',
+        version='1.0',
         packages=['pyOptimalEstimation', ],
         license='GNU General Public License 3',
         author="Maximilian Maahn",
         author_email="maximilian.maahn@colorado.edu",
         classifiers=[
-            "Development Status :: 4 - Beta",
+            "Development Status :: 5 - Production/Stable",
             "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
             "Operating System :: OS Independent",
             "Programming Language :: Python :: 2.7",
@@ -48,5 +48,6 @@
         ],
         install_requires=['numpy', 'matplotlib', 'pandas', 'scipy'],
         long_description=long_description,
-        long_description_content_type='text/markdown'
+        long_description_content_type='text/markdown',
+        url='https://github.com/maahn/pyOptimalEstimation',
     )