===============
Getting started
===============

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

Install using pip

::

    pip install picterra

Set your Picterra API key through an environment variable

::

    export PICTERRA_API_KEY=<your api key>

Listing entities
================

When listing entities (eg rasters, detectors) from your account, the Picterra Server uses a *paginated*
approach; this means that every `list_`-prefixed function returns a special :class:`picterra.ResultsPage` class instance
which can be used like a Python list.

Here are some examples, but look at the doc for :class:`picterra.ForgeClient` and :class:`picterra.TracerClient`
for all the entities you can list.

.. literalinclude:: ../examples/forge/detectors_management.py
.. literalinclude:: ../examples/forge/raster_management.py


Upload & Detect
===============

.. literalinclude:: ../examples/forge/upload_and_detect.py

Training
========

.. note::

  **Please note the below endpoints are still in beta and thus may be subject to change**

.. literalinclude:: ../examples/forge/training.py

Detections in image coordinates
===============================

If you want to use Picterra with images that are not georeferenced and want to get the detector
outputs in (x, y) coordinates, have a look at our `nongeo_imagery notebook <https://github.com/Picterra/picterra-python/blob/master/examples/nongeo_imagery.ipynb>`_ .

More examples
=============

Check the `examples directory <https://github.com/Picterra/picterra-python/tree/master/examples>`_ of our github repo.