Metadata-Version: 2.4
Name: mammos-units
Version: 0.3.1.post0
Summary: Magnetic units package built on top of Astropy units
Project-URL: Homepage, https://mammos-project.github.io
Project-URL: Documentation, https://mammos-project.github.io/mammos
Project-URL: Repository, https://github.com/MaMMoS-project/mammos-units
Project-URL: Issues, https://github.com/MaMMoS-project/mammos-units/issues
Project-URL: Changelog, https://mammos-project.github.io/mammos/changelog
Author-email: Sam Holt <samjrholt@gmail.com>, Hans Fangohr <hans.fangohr@mpsd.mpg.de>, Swapneel Amit Pathak <swapneel-amit.pathak@mpsd.mpg.de>, Martin Lang <martin.lang@mpsd.mpg.de>
License-Expression: MIT
License-File: LICENSE
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.11
Requires-Dist: astropy>=7.0.0
Description-Content-Type: text/markdown

# mammos-units

`mammos-units` is a units package built on top of Astropy units.
It provides additional functionality for magnetic units.

| Description   | Badge                                                                                                                                                                                    |
|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Tests         | [![Test package](https://github.com/MaMMoS-project/mammos-units/actions/workflows/test.yml/badge.svg)](https://github.com/MaMMoS-project/mammos-units/actions/workflows/test.yml)        |
| Linting       | [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/MaMMoS-project/mammos-units/main.svg)](https://results.pre-commit.ci/latest/github/MaMMoS-project/mammos-units/main) |
| Releases      | [![PyPI version](https://badge.fury.io/py/mammos-units.svg)](https://badge.fury.io/py/mammos-units)                                                                                      |
| Documentation | [![Documentation](https://img.shields.io/badge/Docs-mammos--project.github.io%2Fmammos-blue)](https://mammos-project.github.io/mammos/index.html)                                        |
| Binder        | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/mammos-project/mammos-units/latest?urlpath=lab%2Ftree%2Fexamples)                                       |
| License       | [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)                                                                                     |
| DOI           | TODO                                                                                                                                                                                     |


## Try it in the cloud
Try `mammos-units` without installing it locally by directly accessing it directly in the cloud
via Binder.

Simply click the badge in the table above to get started.

Sessions are temporary and may time out after a period of inactivity, and any files
created or modified during your session will not be saved.
To avoid losing your work, please remember to download any files you create or edit
before your session ends.

## Documentation

APIs and tutorials are available in the documentation. To access the documentation, use the badge in the table above.

## Installation

To install `mammos-units`, you can use `pip install mammos-units` inside a Python environment.
For more details refer to the documentation.

## How to cite

TODO

## Acknowledgements

This software has been supported by the European Union’s Horizon Europe research and innovation programme under grant agreement No 101135546 [MaMMoS](https://mammos-project.github.io/) and 101152613.
