Skip to content

Commit 1a64938

Browse files
authored
Merge pull request #17 from CellMigStandOrg/gsergeant-master
Added some documentation in the README
2 parents de67e07 + 11e28b3 commit 1a64938

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[![Build Status](https://travis-ci.org/CellMigStandOrg/CMSO-datasets.svg?branch=master)](https://travis-ci.org/CellMigStandOrg/CMSO-datasets)
2+
[![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
23

34
CMSO datasets
45
=============
@@ -19,10 +20,32 @@ After the curation is performed, the expected metadata files represent the three
1920
How to add a new dataset?
2021
-------------------------
2122

22-
In order to submit a new dataset, a minimal set of information needs to be provided.
23+
In order to submit a new dataset, a minimal set of information needs to be provided based on the [MIACME](https://github.com/CellMigStandOrg/MIACME) guidelines.
2324

2425
How to propose changes to an existing dataset?
2526
----------------------------------------------
2627

2728
We welcome issues in the [tracker](https://github.com/CellMigStandOrg/CMSO-datasets/issues) as well as Pull Requests
2829
suggesting changes to the datasets available in this repository.
30+
31+
How to run the dataset validation code from this repository?
32+
------------------------------------------------------------
33+
34+
If you would like to run locally the dataset validation code from this repository, you can follow the following steps:
35+
36+
1. Clone the repository
37+
```git clone https://github.com/CellMigStandOrg/CMSO-datasets```
38+
1. We suggest you use a python virtual environment. So, if not already installed in your system, first install the virtual environment via `pip`:
39+
`pip install virtualenv`
40+
1. Create a virtual environment:
41+
`virtualenv venv`
42+
1. Then, activate the virtual environment:
43+
`source venv/bin/activate`
44+
1. Install the requirements:
45+
`pip install -r requirements.txt`
46+
1. Validate the ISA metadata:
47+
`python check_isa.py`
48+
1. Validate the biotracks datapackage:
49+
`python check_dpkg.py`
50+
51+

0 commit comments

Comments
 (0)