Bläddra i källkod

[DATALAD] added README

Daniel Busch 1 år sedan
förälder
incheckning
868d03cff4
1 ändrade filer med 98 tillägg och 6 borttagningar
  1. 98 6
      README.md

+ 98 - 6
README.md

@@ -55,7 +55,6 @@ doit download_version --version <YYMMDD>
 doit read_version --version <YYMMDD>
 ```
 
-
 ## <a name="newversion"></a> How to add a new version
 
 
@@ -104,12 +103,8 @@ Get help on a specific command
 doit help <command>
 ```
 
-## Related gin repositories 
-_add a reference to our other gin repositories_
-
-
 ## For developers
-#### Repository structure
+### Repository structure
 - **.datalad/** contains config file for datalad
 - **downloaded_data/** contains original data from Zenodo.
 - **extracted_data/** contains data in .csv and .nc format
@@ -128,3 +123,100 @@ _add a reference to our other gin repositories_
 - **requirements_dev.txt** development requirements
 - **setup.cfg** requirements
 - **setup.py** installs python packages
+
+### Make sure to connect with your siblings
+Git repositories can configure clones of a dataset as _remotes_ in order to fetch, pull, or push from and to them. A `datalad sibling` is the equivalent of a git clone that is configured as a remote. 
+
+**Query information** about about all known siblings with: 
+```
+datalad siblings
+```
+
+**Add a sibling** to allow pushing to github:
+```
+datalad siblings add --dataset . --name <name> --url git@github.com:JGuetschow/Global_CO2_from_cement_production.git
+```
+SSH-access is needed to run this command. Note that _name_ can be freely chosen. 
+
+**Push to the github repository**
+```
+datalad push --to <name>
+
+```
+
+### instructions for merge requests
+# About this dataset
+
+## General information
+
+This is a DataLad dataset (id: 24f90b12-e4a9-4e2c-995d-a54ed4cd49c7).
+
+## DataLad datasets and how to use them
+
+This repository is a [DataLad](https://www.datalad.org/) dataset. It provides
+fine-grained data access down to the level of individual files, and allows for
+tracking future updates. In order to use this repository for data retrieval,
+[DataLad](https://www.datalad.org/) is required. It is a free and open source
+command line tool, available for all major operating systems, and builds up on
+Git and [git-annex](https://git-annex.branchable.com/) to allow sharing,
+synchronizing, and version controlling collections of large files.
+
+More information on how to install DataLad and [how to install](http://handbook.datalad.org/en/latest/intro/installation.html)
+it can be found in the [DataLad Handbook](https://handbook.datalad.org/en/latest/index.html).
+
+### Get the dataset
+
+A DataLad dataset can be `cloned` by running
+
+```
+datalad clone <url>
+```
+
+Once a dataset is cloned, it is a light-weight directory on your local machine.
+At this point, it contains only small metadata and information on the identity
+of the files in the dataset, but not actual *content* of the (sometimes large)
+data files.
+
+### Retrieve dataset content
+
+After cloning a dataset, you can retrieve file contents by running
+
+```
+datalad get <path/to/directory/or/file>
+```
+
+This command will trigger a download of the files, directories, or subdatasets
+you have specified.
+
+DataLad datasets can contain other datasets, so called *subdatasets*.  If you
+clone the top-level dataset, subdatasets do not yet contain metadata and
+information on the identity of files, but appear to be empty directories. In
+order to retrieve file availability metadata in subdatasets, run
+
+```
+datalad get -n <path/to/subdataset>
+```
+
+Afterwards, you can browse the retrieved metadata to find out about subdataset
+contents, and retrieve individual files with `datalad get`.  If you use
+`datalad get <path/to/subdataset>`, all contents of the subdataset will be
+downloaded at once.
+
+### Stay up-to-date
+
+DataLad datasets can be updated. The command `datalad update` will *fetch*
+updates and store them on a different branch (by default
+`remotes/origin/master`). Running
+
+```
+datalad update --merge
+```
+
+will *pull* available updates and integrate them in one go.
+
+### Find out what has been done
+
+DataLad datasets contain their history in the ``git log``.  By running ``git
+log`` (or a tool that displays Git history) in the dataset or on specific
+files, you can find out what has been done to the dataset or to individual
+files by whom, and when.