Commit 5105d11bc006cbd76290cde59782b4ef8c57646c

Authored by Nathanael Jourdane
1 parent 1e543ea0
Exists in master

Add readme for VOTable et EpnTapClient

@@ -0,0 +1,15 @@ @@ -0,0 +1,15 @@
  1 +# EpnTAPClient
  2 +
  3 +The goal of this application is to provide get VOTable data from services which support implements epn-core.
  4 +
  5 +## Dependencies
  6 +
  7 +You need java 7 to execute EpnTAPClient.
  8 +
  9 +## GUI usage
  10 +
  11 +Simply right-click on the jar and select *Open with* -> *Oracle Java 7 RunTime* (for example).
  12 +
  13 +## CLI usage
  14 +
  15 +No CLI usage are provided for now but this is planned.
0 \ No newline at end of file 16 \ No newline at end of file
src/main/java/eu/omp/irap/vespa/epntapclient/votable/README.md 0 → 100644
@@ -0,0 +1,34 @@ @@ -0,0 +1,34 @@
  1 +# VOTable
  2 +
  3 +## Context
  4 +
  5 +This library aims to provide a simple way to parse and view VOTables. The goal is to make the code
  6 +reusable and as light as possible.
  7 +
  8 +## Usage in command-line interface
  9 +
  10 +### 1. Reading a VOTable from an XML file
  11 +
  12 + VOtableApp pathToVOTable
  13 +
  14 +- `pathToVOTable`: The path to your VOTable, ie `~/dowloads/my_votable.xml`.
  15 +
  16 +This will display the VOTable stored in the specified XML file, through a minimalist window.
  17 +
  18 +### 2. Reading a VOTable from an on-line service
  19 +
  20 + VOtableApp targetURL type language query
  21 +
  22 +This will display the VOTable resulting the service or registry request.
  23 +
  24 +- `targetURL`: The URL of the service or registry to ask, ie `http://cdpp-epntap.cesr.fr`;
  25 +- `language`: The language of the query, ie `ADQL`;
  26 +- `query`: The query in the specified language in double quotes, ie. `"SELECT * FROM amdadb.epn_core"`
  27 +
  28 +## Usage from a Java library
  29 +
  30 +Here is a start:
  31 +
  32 + VOTableController myVOTableController = new VOTableController(REGISTRY_URL, "ADQL", QUERY);
  33 +
  34 +See the Javadoc for more informations.
0 \ No newline at end of file 35 \ No newline at end of file