Metadata-Version: 2.1
Name: ubermagutil
Version: 0.2.1
Summary: Python utilities package used across most of Ubermag packages.
Home-page: https://ubermag.github.io
Author: Marijan Beg and Hans Fangohr
License: UNKNOWN
Description: # ubermagutil
        Marijan Beg<sup>1,2</sup> and Hans Fangohr<sup>1,2</sup>
        
        <sup>1</sup> *European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany*  
        <sup>2</sup> *Faculty of Engineering and Physical Sciences, University of Southampton, Southampton SO17 1BJ, United Kingdom*  
        
        | Description | Badge |
        | --- | --- |
        | Release | [![PyPI version](https://badge.fury.io/py/ubermagutil.svg)](https://badge.fury.io/py/ubermagutil) |
        |         | [![Anaconda-Server Badge](https://anaconda.org/conda-forge/ubermagutil/badges/version.svg)](https://anaconda.org/conda-forge/ubermagutil) |
        | Build | [![Build Status](https://travis-ci.org/ubermag/ubermagutil.svg?branch=master)](https://travis-ci.org/ubermag/ubermagutil) |
        |       | [![Build status](https://ci.appveyor.com/api/projects/status/sv9vl65olsl5rxim?svg=true)](https://ci.appveyor.com/project/marijanbeg/ubermagutil) |
        | Coverage | [![codecov](https://codecov.io/gh/ubermag/ubermagutil/branch/master/graph/badge.svg)](https://codecov.io/gh/ubermag/ubermagutil) |
        | Documentation | [![Documentation Status](https://readthedocs.org/projects/ubermagutil/badge/?version=latest)](https://ubermagutil.readthedocs.io/en/latest/?badge=latest) |
        | Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ubermag/ubermagutil/master?filepath=docs%2Fipynb%2Findex.ipynb) |
        | Platforms | [![Platforms](https://anaconda.org/conda-forge/ubermagutil/badges/platforms.svg)](https://anaconda.org/conda-forge/ubermagutil) |
        | Downloads | [![Downloads](https://anaconda.org/conda-forge/ubermagutil/badges/downloads.svg)](https://anaconda.org/conda-forge/ubermagutil) |
        | License | [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) |
        
        ## About
        
        `ubermagutil` is a Python package that provides:
        
        - Descriptors and the typesystem decorator used in [Ubermag](http://ubermag.github.io) packages
        
        It is available on all major operating systems (Windows, MacOS, Linux) and requires Python 3.6 or higher.
        
        ## Installation, testing, and upgrade
        
        We support installation using `conda` and `pip` package managers. Instructions can be found [here](https://ubermagutil.readthedocs.io/en/latest/ipynb/00-tutorial-installation-testing-upgrade.html).
        
        ## Binder
        
        This package can be used in the cloud via Binder. This does not require you to have anything installed and no files will be created on your machine. To access Binder, use this [link](https://mybinder.org/v2/gh/ubermag/ubermagutil/master?filepath=docs%2Fipynb%2Findex.ipynb).
        
        ## Documentation
        
        Documentation is available [here](https://ubermagutil.readthedocs.io/en/latest/), where APIs and tutorials as Jupyter notebooks are available.
        
        ## Support
        
        If you require support or have any questions, you are welcome to raise an issue in our [ubermag/help](https://github.com/ubermag/help) repository.
        
        ## License
        
        Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the [LICENSE](LICENSE) file.
        
        ## How to cite
        
        If you use this package in your research, please cite it as:
        
        1. M. Beg, R. A. Pepper, and H. Fangohr. User interfaces for computational science: A domain specific language for OOMMF embedded in Python. [AIP Advances, 7, 56025](http://aip.scitation.org/doi/10.1063/1.4977225) (2017).
        
        2. DOI will be available soon
        
        ## Acknowledgements
        
        Developed as a part of [OpenDreamKit](http://opendreamkit.org/) – Horizon 2020 European Research Infrastructure project (676541).
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Description-Content-Type: text/markdown
