diff --git a/README.md b/README.md index 95ad6c17febf3a5bd178894d65f3ee51bcaac208..6f3b0f58a17ba2b2bb43807bdb0ea2572891018b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,30 @@ -# NES +# About -NetCDF for Earth Science +NES (NetCDF for Earth Science) is the Python I/O library used by SNES, the framework that implements the data post-processing pipelines at the Earth Sciences department, to read and write netCDF files. -test local \ No newline at end of file +# How to clone + +Use the following command to get a copy of the repository: + +``` +git clone https://earth.bsc.es/gitlab/es/NES.git +``` + +You can use the latest stable version of Providentia +by accessing the production branch: + +``` +git checkout production +``` + +You can also access the master branch to test new features, +that are to be implemented in the upcoming release: + +``` +git checkout master +``` + +# Run + +For running NES, please follow the instruction in +the [Wiki](https://earth.bsc.es/gitlab/es/NES/-/wikis/home). \ No newline at end of file