{ "info": { "author": "Achilleas Koutsou, Julia Sprenger", "author_email": "dev@g-node.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Scientific/Engineering" ], "description": "![Travis build](https://travis-ci.org/G-Node/nix-odML-converter.svg?branch=master)\n[![Build status](https://ci.appveyor.com/api/projects/status/fc30meltvawsbpgt?svg=true)](https://ci.appveyor.com/project/G-Node/nix-odml-converter)\n[![PyPI version](https://img.shields.io/pypi/v/nixodmlconverter.svg)](https://pypi.org/project/nixodmlconverter/)\n\n\n# odML \u2194\ufe0f NIX metadata conversion tool\n\nThis tool reads in [odML](https://g-node.github.io/python-odml/) / \n[NIX](https://g-node.github.io/nix/) files and writes the metadata structure to newly \ncreated NIX / odML files. When run as a script from the command line, it prints \ninformation regarding the number of Sections and Properties that were read, written, \nor skipped for various reasons.\n\nFor more information on the odML and NIX data formats, please check the sections below.\n\n## Installation\n\nYou can easily install the converter via the Python package manager `pip`.\n\n pip install nixodmlconverter\n\n## Usage\n\nAfter installing the package, you can use the `convert.py` script found in the\ndirectory 'nix-odML-converter/nixodmlconverter' that acts as a command line tool.\n\nYou can use it to a) import the content of an existing odML file into a NIX file or\nb) to export the odML content of a NIX file into a new odML file. \n\n### Import of odML into a NIX file\n\nFrom the command line use the `convert.py` script to import the contents of an existing\nodML file into a NIX file:\n\n python nix-odML-convert/nixodmlconverter/convert.py odmlfile.xml nixfile.nix \n\nThe odML file has to be provided in XML format. \n\n### Export odML from a NIX file\n\nFrom the command line use the `convert.py` script to export the contents of an existing \nNIX file to a new odML file:\n\n python nix-odML-convert/nixodmlconverter/convert.py nixfile.nix newodmlfile.xml\n\n### Usage notes\n\nFor compatibility with the NIX metadata format, which differs slightly from the \nodML format, the following modifications occur when converting from odML to NIX:\n\n- If a Section has a `reference` create a property called `reference`\n- If a Property has a `reference` put the reference in the Property's values\n- Values of type `URL`, `person`, and `text` are treated as strings\n- Values of type `datetime`, `date`, and `time` are converted to string representations\n- Values of type `binary` are discarded\n\n\n## Building from source\n\nYou can also install the package by cloning the github repository and\ninstalling from source.\n\n git clone https://github.com/G-Node/nix-odML-converter.git\n cd nix-odML-converter\n python setup.py install\n\n## Dependencies\n\n* Python 2.7 or 3.5+\n* Python packages:\n * odml\n * nixio (>=1.5.0b1)\n\nThese dependency packages can be manually installed via the python package manager `pip`:\n\n`pip install odml nixio==1.5.0b3` \n\nor by manually installing the nix-odML-converter from the repository root:\n\n`python setup.py install`\n\n\n# NIX (Neuroscience information exchange) format\n\nThe NIX data model allows to store fully annotated scientific datasets, i.e. the \ndata together with its metadata within the same container. Our aim is to achieve \nstandardization by providing a common/generic data structure for a multitude of \ndata types.\n\nThe source code of the core python library is freely available on \n[GitHub](https://github.com/G-Node/nixpy) and can be installed via the \nPython package manager `pip` by typing `pip install nixio`.\n\nMore information about the project including related projects as well as tutorials and\nexamples can be found at our odML [project page](https://g-node.github.io/nix/).\n\n\n# odML (Open metaData Markup Language) format\n\nThe open metadata Markup Language is a file based format (XML, JSON, YAML) for storing\nmetadata in an organised human- and machine-readable way. odML is an initiative to define\nand establish an open, flexible, and easy-to-use format to transport metadata.\n\nThe source code of the core library is freely available on \n[GitHub](https://github.com/G-Node/python-odml) and can be installed via the \nPython package manager `pip` by typing `pip install odml`.\n\nMore information about the project including related projects as well as tutorials and\nexamples can be found at our odML [project page](https://g-node.github.io/python-odml/).", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/G-Node/nix-odml-converter", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "nixodmlconverter", "package_url": "https://pypi.org/project/nixodmlconverter/", "platform": "", "project_url": "https://pypi.org/project/nixodmlconverter/", "project_urls": { "Homepage": "https://github.com/G-Node/nix-odml-converter" }, "release_url": "https://pypi.org/project/nixodmlconverter/0.0.5/", "requires_dist": null, "requires_python": "", "summary": "Converter between NIX and odML format", "version": "0.0.5" }, "last_serial": 5117584, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "8475c7a4e682cf5149930d808e85e35c", "sha256": "9b2d7633d69e07e5504c6a3ef0bfdf79a49f0caf1a41f979ec248accffb3bf81" }, "downloads": -1, "filename": "nixodmlconverter-0.0.1.tar.gz", "has_sig": false, "md5_digest": "8475c7a4e682cf5149930d808e85e35c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4402, "upload_time": "2018-09-22T10:32:06", "url": "https://files.pythonhosted.org/packages/b2/88/b4320acf1a10ee83a62bec6354730abd3f566e5ec91fed25943f3bdfacbb/nixodmlconverter-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "8ec189489d6851f7e80ec35771d8ad8d", "sha256": "996da4e78ca931026fed39a832f4deb7a7a331ff8ed8c464a398a335ce7d2186" }, "downloads": -1, "filename": "nixodmlconverter-0.0.2.tar.gz", "has_sig": false, "md5_digest": "8ec189489d6851f7e80ec35771d8ad8d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6120, "upload_time": "2019-01-31T13:31:51", "url": "https://files.pythonhosted.org/packages/9f/b5/ab1ccb12606454c8e836ce54005dfdeac96eea77145ec5f3fc28e00bbc83/nixodmlconverter-0.0.2.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "1c66e784334b72797979da74d91decc5", "sha256": "84a662be8fc66c846b9a1a736e13738909ff62d4fe79455f80c540c91b847987" }, "downloads": -1, "filename": "nixodmlconverter-0.0.5.tar.gz", "has_sig": false, "md5_digest": "1c66e784334b72797979da74d91decc5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9642, "upload_time": "2019-04-09T08:43:46", "url": "https://files.pythonhosted.org/packages/e4/25/e98cdc1d0631fc71728cf887f14b55f96a95c2a037b1c1d50f73d6448ff5/nixodmlconverter-0.0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1c66e784334b72797979da74d91decc5", "sha256": "84a662be8fc66c846b9a1a736e13738909ff62d4fe79455f80c540c91b847987" }, "downloads": -1, "filename": "nixodmlconverter-0.0.5.tar.gz", "has_sig": false, "md5_digest": "1c66e784334b72797979da74d91decc5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9642, "upload_time": "2019-04-09T08:43:46", "url": "https://files.pythonhosted.org/packages/e4/25/e98cdc1d0631fc71728cf887f14b55f96a95c2a037b1c1d50f73d6448ff5/nixodmlconverter-0.0.5.tar.gz" } ] }