README.rst 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. studyforrest.org Dataset
  2. ************************
  3. |license| |access| |doi|
  4. Some
  5. ====
  6. For more information about the project visit: http://studyforrest.org
  7. How to obtain the data files
  8. ----------------------------
  9. This repository contains metadata and information on the identity of all
  10. included files. However, the actual content of the (sometime large) data
  11. files is stored elsewhere. To obtain any dataset component, git-annex_ is
  12. required in addition to Git_.
  13. 1. Clone this repository to the desired location.
  14. 2. Enter the directory with the local clone and run::
  15. git annex init
  16. Older versions of git-annex may require you to run the following
  17. command immediately afterwards::
  18. git annex enableremote mddatasrc
  19. Now any desired dataset component can be obtained by using the ``git annex get``
  20. command. To obtain the entire dataset content run::
  21. git annex get .
  22. Keep data up-to-date
  23. --------------------
  24. If updates to this dataset are made in the future, update any local clone by
  25. running::
  26. git pull
  27. followed by::
  28. git annex get .
  29. to fetch all new files.
  30. .. _Git: http://www.git-scm.com
  31. .. _git-annex: http://git-annex.branchable.com/
  32. .. |license|
  33. image:: https://img.shields.io/badge/license-PDDL-blue.svg
  34. :target: http://opendatacommons.org/licenses/pddl/summary
  35. :alt: PDDL-licensed
  36. .. |access|
  37. image:: https://img.shields.io/badge/data_access-unrestricted-green.svg
  38. :alt: No registration or authentication required
  39. .. |doi|
  40. image:: https://img.shields.io/badge/doi-missing-lightgrey.svg
  41. :target: http://dx.doi.org/
  42. :alt: DOI