salamanca: A Python Toolbox for Economic and Monetary Analysis
==============================================================

Release v\ |version|.

|pypi| |rtd| |license|
|tests| |codecov|

.. |pypi| image:: https://img.shields.io/pypi/v/salamanca.svg
   :target: https://pypi.python.org/pypi/salamanca/

.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-black
   :target: https://github.com/IAMconsortium/pyam/blob/master/LICENSE

.. |tests| image:: https://github.com/gidden/salamanca/actions/workflows/test.yml/badge.svg
   :target: https://github.com/gidden/salamanca/actions/workflows/test.yml

.. |codecov| image:: https://coveralls.io/repos/github/gidden/salamanca/badge.svg?branch=master
    :target: https://coveralls.io/github/gidden/salamanca?branch=master

.. |rtd| image:: https://readthedocs.org/projects/salamanca/badge/?version=latest
   :target: https://salamanca.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status


**salamanca** is a Python package for working with economic and monetary data,
including supporting currency conversion calculations. It provides a robust API and and 
Command Line Interface (CLI).

Documentation
-------------

.. toctree::
   :maxdepth: 2

   starting
   install
   api
   cli



Get in touch
------------

- Report bugs, suggest features or view the source code `on GitHub`_.
- For less well defined questions or ideas, use the `mailing list`_.

.. _mailing list: https://groups.google.com/forum/#!forum/salamanca-python
.. _on GitHub: http://github.com/gidden/salamanca

License
-------

salamanca is available under the open source `Apache License`_.

.. _Apache LIcense: http://www.apache.org/licenses/LICENSE-2.0.html