Skip to content

adding intro docs to tools #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,51 @@ $ python setup.py --quiet install
#running the tests
$ python -m unittest discover -s bald.tests -v
```

## Command line tools

### ncldDump

A HTML 'hot-linked' version of the `ncdump` command-line utility.
The output of `ncldDump` is a something similar but with links to the standard names
and definitions of the attributes to source documentation. See https://binary-array-ld.github.io/netcdf-ld/examples/avhrr-only-v2.19810901_a.html for
example output HTML.

See more here https://github.com/jyucsiro/bald/tree/master/ncldDump

Getting started:
```
$ cd ncldDump
#Install requirements
$ pip install -r ../requirements.txt

#run
$ python ncldDump.py -a aliases.json -o test.html test.nc
```


### nc2rdf

A command-line tool that takes a netCDF or CDL file and outputs an RDF or JSON-LD encoding of the
content. The RDF can then be imported into RDF triple stores or used with RDF libraries for
reasoning, SPARQL querying and the like.

The RDFLib package is used so serialisation options to RDF are: `n3`, `nquads`, `nt`, `rdfxml`, `turtle` or `ttl`.

See more here https://github.com/jyucsiro/bald/tree/master/nc2rdf

```
$ cd nc2rdf

# turn CDL into RDF
$ python nc2rdf.py test.cdl

# turn NC into RDF
$ python nc2rdf.py test.nc

# specify RDF formats/flavours
$ python nc2rdf.py -o turtle test.nc

```