Application Programming Interface

For a didactic introduction to the API objects, please visit the API tutorial pages.

The API of antares relies on a hierarchical data structure. Let’s see the ABC.

---

Antares Basic Classes

The root node of this four-level hierarchical structure is an instance of the Base class. The child nodes of the root node are instances of the Zone class. An instance of the Base class (named a Base in the following) is essentially a container of Zone instances. Each Zone is basically a collection of Instant instances. Each Instant is a container of variables.

Click on any of the object to access its detailed documentation.

---

Antares Topological Classes

• Boundary
• Family
• Window

Antares I/O Classes

• Reader
• Lazy Loading Pattern
• Writer

Available Formats:

• Available Reader Formats
• Available Writer Formats

Antares Treatment Classes

• Treatments

Antares Helper Functions and Utilities

Progress Bar

A progress bar is available in some functions, methods, and treatments. It relies on the package tqdm. If this package is not available, then you recover the old Antares 1.8.2 progress bar.

antares.set_progress_bar(value=False)

Set the progress bar status (on/off).

Parameters:

value (bool) – status of the progress bar

antares.disable_progress_bar()

Disable the progress bar status.