source: flex_extract.git/README.md @ 87ae9a3

dev
Last change on this file since 87ae9a3 was adb0b63, checked in by Anne Philipp <anne.philipp@…>, 11 months ago

Changed license writing and added information for Readme writing

  • Property mode set to 100644
File size: 3.4 KB
Line 
1# README #
2
3This directory contains programs to generate FLEXPART WINDFIELDS from ECMWF ERA-Interim data.
4
5+ `python  contains python scripts to extract and generate WINDFIELDS
6+ `src contains Fortran source code to create CONVERT2 executable (used by the python scripts)
7+ `grib_templates contains GRIB-API templates for running CONVERT2 program.
8
9+ `please read SIP.doc and SUT.doc for detailed installation and usage instructions
10
11Please report any problems.
12
13======================================================================================================
14
15
16
17# license added by me
18with url
19<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
20
21with pic
22<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="/documentation/Sphinx/source/_static/cc-by-40.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
23
24
25# Product Name
26> Short blurb about what your product does.
27
28[![NPM Version][npm-image]][npm-url]
29[![Build Status][travis-image]][travis-url]
30[![Downloads Stats][npm-downloads]][npm-url]
31
32One to two paragraph statement about your product and what it does.
33
34![](header.png)
35
36## Installation
37
38OS X & Linux:
39
40```sh
41npm install my-crazy-module --save
42```
43
44Windows:
45
46```sh
47edit autoexec.bat
48```
49
50## Usage example
51
52A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.
53
54_For more examples and usage, please refer to the [Wiki][wiki]._
55
56## Development setup
57
58Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
59
60```sh
61make install
62npm test
63```
64
65## Release History
66
67* 0.2.1
68    * CHANGE: Update docs (module code remains unchanged)
69* 0.2.0
70    * CHANGE: Remove `setDefaultXYZ()`
71    * ADD: Add `init()`
72* 0.1.1
73    * FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!)
74* 0.1.0
75    * The first proper release
76    * CHANGE: Rename `foo()` to `bar()`
77* 0.0.1
78    * Work in progress
79
80## Meta
81
82Your Name – [@YourTwitter](https://twitter.com/dbader_org) – YourEmail@example.com
83
84Distributed under the XYZ license. See ``LICENSE`` for more information.
85
86[https://github.com/yourname/github-link](https://github.com/dbader/)
87
88## Contributing
89
901. Fork it (<https://github.com/yourname/yourproject/fork>)
912. Create your feature branch (`git checkout -b feature/fooBar`)
923. Commit your changes (`git commit -am 'Add some fooBar'`)
934. Push to the branch (`git push origin feature/fooBar`)
945. Create a new Pull Request
95
96<!-- Markdown link & img dfn's -->
97[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square
98[npm-url]: https://npmjs.org/package/datadog-metrics
99[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square
100[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
101[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics
102[wiki]: https://github.com/yourname/yourproject/wiki
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG