Metadata-Version: 2.1
Name: opencal
Version: 3.8.0
Summary: OpenCAL core library for Python
Author-email: Jérémie DECOCK <jd.jdhp@gmail.com>
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pyyaml

=======
OpenCAL
=======

Copyright (c) 2008-2019 Jérémie DECOCK (www.jdhp.org)

* Web site: http://www.jdhp.org/software_en.html#opencal
* Online documentation: https://opencal.gitlab.io/opencal-lib-python
* Examples: https://opencal.gitlab.io/opencal-lib-python/gallery/

* Notebooks: https://gitlab.com/opencal/opencal-lib-python-notebooks
* Source code: https://gitlab.com/opencal/opencal-lib-python
* Issue tracker: https://gitlab.com/opencal/opencal-lib-python/issues
* OpenCal on PyPI: https://pypi.org/project/opencal


Description
===========

OpenCAL core library for Python

Note:

    This project is still in beta stage, so the API is not finalized yet.


Scientific references
=====================

See https://gitlab.com/opencal/opencal-lib-scientific-references


Dependencies
============

*  Python >= 3.0

.. _install:

Installation
============

Gnu/Linux
---------

You can install, upgrade, uninstall OpenCAL with these commands (in a
terminal)::

    pip install --pre opencal
    pip install --upgrade opencal
    pip uninstall opencal

Or, if you have downloaded the OpenCAL source code::

    python3 setup.py install

.. There's also a package for Debian/Ubuntu::
.. 
..     sudo apt-get install opencal

Windows
-------

.. Note:
.. 
..     The following installation procedure has been tested to work with Python
..     3.4 under Windows 7.
..     It should also work with recent Windows systems.

You can install, upgrade, uninstall OpenCAL with these commands (in a
`command prompt`_)::

    py -m pip install --pre opencal
    py -m pip install --upgrade opencal
    py -m pip uninstall opencal

Or, if you have downloaded the OpenCAL source code::

    py setup.py install

MacOSX
-------

.. Note:
.. 
..     The following installation procedure has been tested to work with Python
..     3.5 under MacOSX 10.9 (*Mavericks*).
..     It should also work with recent MacOSX systems.

You can install, upgrade, uninstall OpenCAL with these commands (in a
terminal)::

    pip install --pre opencal
    pip install --upgrade opencal
    pip uninstall opencal

Or, if you have downloaded the OpenCAL source code::

    python3 setup.py install


Documentation
=============

* Online documentation: https://opencal.gitlab.io/opencal-lib-python
* API documentation: https://opencal.gitlab.io/opencal-lib-python/api.html


Example usage
=============

TODO


Bug reports
===========

To search for bugs or report them, please use the OpenCAL Bug Tracker at:

    https://gitlab.com/opencal/opencal-lib-python/issues


License
=======

This project is provided under the terms and conditions of the `MIT License`_.


.. _MIT License: http://opensource.org/licenses/MIT
.. _command prompt: https://en.wikipedia.org/wiki/Cmd.exe
