Skip to content

Commit

Permalink
Start on documentation and increase the version to make a new pip module
Browse files Browse the repository at this point in the history
  • Loading branch information
trygveasp committed Nov 26, 2020
1 parent 1091cb9 commit 9bb06f3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
21 changes: 13 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. _README:

.. image:: https://coveralls.io/repos/github/metno/pysurfex/badge.svg?branch=master

https://coveralls.io/github/metno/pysurfex

Python API to SURFEX (pysurfex)
Expand All @@ -20,22 +21,28 @@ See online documentation in https://metno.github.io/pysurfex/
Installation on debian based Linux system
--------------------------------------------

Install the required pacakges:
Install the required pacakges (some might be obsolete if the pip packages contain the needed depedencies):

.. code-block:: bash
sudo apt-get update
# Python tools
sudo apt-get install python3-setuptools python3-numpy python3-scipy
sudo apt-get install python3-setuptools python3-numpy python3-scipy python3-nose
# Cfunits
sudo apt-get install libudunits2-dev
# Projection
sudo apt-get install python3-pyproj
# Eccodes for bufr/grib1/grib2
sudo apt-get install libeccodes0 libeccodes-dev
# Ecflow for user experiements
sudo apt-get install ecflow-server ecflow-client python3-ecflow
# Titanlib
sudo apt-get install libboost-dev libproj-dev libarmadillo-dev libgsl-dev
The following depencies are needed. Install the non-standard ones e.g. with pip or your system installation system.

General dependencies
---------------------
General dependencies from pypi
--------------------------------

.. code-block:: bash
Expand Down Expand Up @@ -103,7 +110,7 @@ For testing:
unittest
nose
Testdata from https://drive.google.com/open?id=1CCcKqRUp7fwZKGzWHXMjBxaXKVWWQiTO
Testdata from https://docs.google.com/uc?export=download&id=1FSNRQE998-ulBq8GZ0zZ40cP-TLrQulV
Download the source code, then install ``pysurfex`` by executing the following inside the extracted
folder:
Expand Down Expand Up @@ -132,6 +139,4 @@ Create documentation
Examples
-----------------------

.. include:: docs/example.rst


See https://metno.github.io/pysurfex/#examples
2 changes: 1 addition & 1 deletion surfex/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.0.1a5'
__version__ = '0.0.1a6'

from .file import *
from .geo import *
Expand Down

0 comments on commit 9bb06f3

Please sign in to comment.