Changes between Version 8 and Version 9 of SoftWare/ProjectMeta


Ignore:
Timestamp:
Apr 27, 2018, 7:08:46 PM (7 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • SoftWare/ProjectMeta

    v8 v9  
    99
    1010== Description ==
    11 The creation of the OpenDAP repository is done by the script [http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/project-meta/project-meta.html project-meta] (**which langage). The first step is to make a list of the data folders to display. This list needs to be introduced in a text file, complemented by some information about the authors of the work and about related publications. This text file must be put in your current folder with the name `PROJECT-META.yml`. The text structure must follow some simple rules consisting in the YAML format. An example could be found in the Project-Meta repository or online [http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/project-meta/PROJECT-META.sample.yml PROJECT-META.sample.yml].
     11The creation of the OpenDAP repository is done by the script [http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/project-meta/project-meta.html project-meta] (**which language).
    1212
    13 At this stage, Project-Meta is at a early stage of develepment. Many aspect of it will be improve in the future.
     13The first step is to make a list of the data folders to display. This list needs to be introduced in a text file, complemented by some information about the authors of the work and about related publications. This text file must be put in your current folder with the name `PROJECT-META.yml`. The text structure must follow some simple rules consisting in the YAML format. An example could be found in the Project-Meta repository or online [http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/project-meta/PROJECT-META.sample.yml PROJECT-META.sample.yml].
    1414
    1515== `PROJECT-META.yml` meta file ==
    16 This file is the core of the project. One difficult task is to list all your open data. Sometime, it's very easy, sometime it's could be painful and time consuming, especially if there is a lot of data
    17 
    18 Here an example to append all the folder of kind '`*.mproj*`' (Coriolis example for some open data) at the end of the `PROJECT-META.yml` file.
     16This file is the core of the project. A first task is to list the data folder to publish. A good practice is to organise the data and the procedures of analysis, such that the final data to publish are contained in folders named with specific extensions. Then finding tools can be used to list all the selected folders. For instance the following unix command lists all the folders with extension '`*.mproj*`' and append it to the file `PROJECT-META.yml` (and creates the file if it does not exist yet):
    1917
    2018{{{
    2119find . -name '*.mproj*' -a -type d | sed 's/^/    - /;' >> PROJECT-META.yml
    2220}}}
    23 The `find` command only search the right folders under the current one (.) and the `sed` command add 4 spaces and the dash at the beginning of each line in order to respect the YAML format.
     21The `find` command only search the folders with the right extension (recursively)  under the current one (.) and the `sed` command add 4 spaces and the dash at the beginning of each line in order to respect the YAML format.
     22
     23The YAML file has to be complemented by general information about the authors and the related publications, following the template  [http://servforge.legi.grenoble-inp.fr/pub/soft-trokata/project-meta/PROJECT-META.sample.yml PROJECT-META.sample.yml].
    2424
    2525== Repository ==