.. _a_api:

Hydrodynamic calculation core API
=================================

Our `Hydrodynamic calculation core API <https://hcc-api.ranawaterintelligence.com/v3/>`_ allows scripts and software applications to interact with all Rana online resources and services.

This gives you a lot of flexibility to your modelling applications and can save you lots of manual work and time. Some examples of applications of the API are:

- Batch simulations: run simulations with hundreds of different rain events.
- Automated test runs, results checks and adjustments to a model before running another simulation.
- Run Rana simulations in an operational system, such as a Flood Early Warning System.
- Use Jupyter Notebooks to run, download and analyze your Rana simulations.
- Design your own control for weirs or other structures.

See the separate Hydrodynamic calculation core API `documentation <https://hcc-api.ranawaterintelligence.com/v3/docs/>`_ for more details. 

Using the Hydrodynamic calculation core API from Python is easy using `threedi-api-client <https://pypi.org/project/threedi-api-client/>`_.

An overview of the endpoints (and their documentation) can be found on the `Swagger page <https://hcc-api.ranawaterintelligence.com/v3/swagger/>`_.

Additional example scripts can be found in `here <https://github.com/threedi/scripts-nens/tree/master/Notebooks%203Di%20-%20API%20v3%20-%20VD>`_.