Metadata-Version: 2.1
Name: compositionspace
Version: 0.0.7
Summary: APT analysis tools
Home-page: 
Author: Alaukik Saxena, Sarath Menon, Mariano Forti
Author-email: s.menon@mpie.de
Keywords: compositionspace
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# CompositionSpace

CompositionSpace is a python library for analysis of APT data.

## Installation

### Installation using [Conda](https://anaconda.org/)

It is **strongly** recommended to install and use `calphy` within a conda environment. To see how you can install conda see [here](https://docs.conda.io/projects/conda/en/latest/user-guide/install/).

Once a conda distribution is available, the following steps will help set up an environment to use `compositionspace`. First step is to clone the repository.

```
https://github.com/eisenforschung/CompositionSpace.git
```

After cloning, an environment can be created from the included file-

```
cd CompositionSpace
conda env create -f environment.yml
```

Activate the environment,

```
conda activate compspace
```

then, install `compositionspace` using,

```
python setup.py install
```
The environment is now set up to run calphy.

## Examples

For an example of the complete workflow using `compositionspace`, see `example/full_workflow.ipynb`.

The provided dataset is a small one for testing purposes, which is also accessible here:

Ceguerra, AV (2021) Supplementary material: APT test cases.
Available at http://dx.doi.org/10.25833/3ge0-y420

## Documentation

Documentation is available [here](https://compositionspace.readthedocs.io/en/latest/).
