Metadata-Version: 2.1
Name: sparc-converter
Version: 0.2.0
Summary: Applications to convert SPARC data.
Home-page: https://github.com/hsorby/sparc-converter.git
Author: Hugh Sorby
Author-email: h.sorby@auckland.ac.nz
License: Apache Software License
Platform: UNKNOWN
Description-Content-Type: text/x-rst
License-File: LICENSE


SPARC Converter
===============

Python applications to convert data from one format to another.

Usage
-----

Basic usage instructions::

 usage: sparc-convert [-h] [-o OUTPUT_DIR] {web-gl} ...

 Convert SPARC data.

 positional arguments:
   {web-gl}              Choose a command
     web-gl              export to WebGL

 optional arguments:
   -h, --help            show this help message and exit
   -o OUTPUT_DIR, --output-dir OUTPUT_DIR
                         specify the output directory


Usage instructions for *web-gl* command::

  usage: sparc-convert web-gl [-h] [-p PREFIX] argon_doc

  positional arguments:
    argon_doc             an Argon document

  optional arguments:
    -h, --help            show this help message and exit
    -p PREFIX, --prefix PREFIX
                          set web-gl output prefix

Example
-------

::

  sparc-convert web-gl <path-to-argon-file>/CubeSquareLine.neon -o webgl

License
=======

::

   Copyright 2021 University of Auckland

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


