Metadata-Version: 2.1
Name: pycalphad-xml
Version: 0.1
Summary: XML database plugin for pycalphad
Home-page: https://github.com/pycalphad/pycalphad-xml
Author-email: Richard Otis <richard.otis@outlook.com>, Brandon Bocklund <brandonbocklund@gmail.com>
License: MIT License
        
        Copyright (c) 2022 pycalphad
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/pycalphad/pycalphad-xml
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE

# pycalphad-xml
XML database plugin for PyCalphad

This package (including the RelaxNG-based schemas that support it) are considered experimental and are likely to change.
We welcome any feedback and encourage you to report issues or suggestions to us on our [GitHub issues page](https://github.com/pycalphad/pycalphad-xml/issues)!

## Installing

```shell
pip install pycalphad-xml
```

## Usage

PyCalphad version 0.10.1 or later will automatically detect this packge as a plugin and load register the XML reader and writer with PyCalphad's `Database` interface.

Databases can be loaded and used as any other supported format:

```python
from pycalphad import Database

dbf = Database("my_db.xml")  # load from file

dbf.to_file("out.xml")  # write to a file
```

## Development versions

To install the development version of `pycalphad-xml`, clone the repository and install it in editable mode with `pip`:

```shell
git clone git@github.com:pycalphad/pycalphad-xml.git
pip install -e .
```


