Skip to main content

Annapurna Suite Python SDK

Automate your Annapurna workspace from Python: projects, points, block models, drillholes, surfaces, meshes, modeling instances, sharing and Compute jobs.

pip install annapurna

Authenticate

Create a key in Account Settings → API Key, then keep it out of your code:

export ANNAPURNA_API_KEY="aps_live_..."          # Windows: setx ANNAPURNA_API_KEY "aps_live_..."
export ANNAPURNA_ENV="prod"      # optional: "prod" (default, api.annapurnasuite.com) or "dev" (dev-api.annapurnasuite.com)
import annapurna as ap

client = ap.Client()          # or ap.Client(api_key=..., environment="dev")
print(client.whoami())

Work with a project

proj = client.project("Fireweed")          # client.project() = active project
proj.objects()                             # everything, grouped by kind

# Block models / points ------------------------------------------------------
bm = proj.block_models.read("BM_123", columns=["Easting", "Northing", "Elevation", "Au"])
proj.block_models["BM_123"].clone("BM_123_backup")
proj.block_models.rename("BM_123_backup", "BM_123_v1")
proj.block_models.reblock("BM_123", "BM_123_25m", size=(25, 25, 10), weight_column="Density")
proj.points.upload("Comps_2026", comps_df)                  # refuses to overwrite unless overwrite=True
proj.points.rename_columns("Comps_2026", {"AU": "Au_gpt"})
proj.points.delete("Old_Comps")

# Drillholes ------------------------------------------------------------------
proj.drillholes.list()                       # drillhole projects
proj.drillholes.tables("Fireweed_DH")        # their tables
assays = proj.drillholes.read("Fireweed_DH", "Assays")

# Surfaces & meshes (OBJ) -------------------------------------------------------
proj.meshes.upload("Ore_Shell", "shell.obj")
proj.surfaces.download("Topo_2025", "topo.obj")

Modeling instances

inst = proj.instances
inst.upload("Au_OK", method="kriging", csv="params.csv")    # path, CSV text or DataFrame
result = inst.run("Au_OK", wait=True)                       # blocks until Completed/Failed/Killed
print(result.status, result.run_time)

# Edit the parameter table (index = parameter, columns = runs, values as text)
df = inst.load("SGS_Iter_0")
df.loc["num_reas"] = "50"
inst.save("SGS_Iter_1", df)        # new instance (method from the 'method' row), or
inst.save("SGS_Iter_0", df)        # replace the parameters of an existing one

Compute: evaluate geometries

from annapurna import GeometryMapping as G

proj.evaluate(
    "block_models", "BM_123", attribute="Domain", default_label="WASTE",
    mappings=[G("Ore_Shell", "ORE"), G("Topo_2025", "AIR", geometry_type="surface", side="above")],
)

Share datasets

code = proj.share("block_models", "BM_123")      # give code.access_code and code.password (separately)
client.sharing.preview(access_code, password)
client.project("Target").import_shared(access_code, password)

Inside Annapurna (Project Scripting page)

ap is already loaded and works without a key:

ap.list_datasets("block_models")
bm = ap.load("block_models", "BM_123")
ap.save(bm.describe(), "reports/summary.csv")

print(ap.list_instances())
params = ap.load_instance("SGS_Iter_0")
params.loc["num_reas"] = "50"
ap.save_instance(params, "SGS_Iter_1")

Platform modules

The modules of the platform pages are functions of ap inside Annapurna. Each one runs for the open project and waits for the result; chart modules save their PNG figures to Disk:

ap.histogram("points", "Comps_2026", ["Au", "Cu"], bins=40)
stats = ap.statistics("block_models", "BM_2026", ["Au"], break_by="Zone")
ap.compositing("DH_2026", "Assays", "Assays_Comp5", length=5)
ap.cumulative("points", "Comps_2026", ["Au"], break_by="Domain", save_to="report/cdf")
print(ap.MODULES)

Disk files and PDF reports

print(ap.disk_list("figures/contact_analysis", pattern="*.png"))
ap.figures_to_pdf("figures/contact_analysis", "reports/contacts.pdf")

figs = ap.contact_analysis("Comps_2026", "cut", contact="ue_cut")
figs.to_pdf("reports/contacts.pdf")

Errors

Every error derives from ap.AnnapurnaError: AuthenticationError, PermissionDeniedError, NotFoundError, ConflictError, ValidationError, RateLimitError, ServerError, APIConnectionError, TaskFailedError, TaskTimeoutError.

Security

  • The key is read from the environment, sent only to base_url over HTTPS, and never printed.
  • Redirects are not followed with the key; file transfers use short-lived signed URLs without the key.
  • Names are validated and URL-encoded, so they cannot alter request paths.
  • TLS verification cannot be disabled (use verify="/path/ca.pem" for corporate proxies).
  • Revoke a leaked key immediately in Account Settings.

Upgrading from 0.0.x

Old flat methods (client.read_parquet, client.upload_points, client.run_instance, …) still work and print a DeprecationWarning that names the new call. whoami() now returns an Identity object (dict-style access me["username"] still works).

Metadata

Release files for annapurna 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for annapurna 0.2.1
File Size Uploaded Provenance Actions
annapurna-0.2.1.tar.gz 68.0 kB Without provenance Details for annapurna-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for annapurna 0.2.1
File Interpreter ABI Platform Actions
annapurna-0.2.1-py3-none-any.whl Python 3 none any Details for annapurna-0.2.1-py3-none-any.whl

Total release size: 144.6 kB

Release files / annapurna-0.2.1.tar.gz

Download URL annapurna-0.2.1.tar.gz
Size 68.0 kB
Tags Source
SHA-256 checksum
How to use checksums
ee9f6f974713ef2e5215057c5914db26fd6f89b3ec306c1ffe93046d4a95de0d
BLAKE2b-256 checksum
How to use checksums
37349e63d4b75dc958f3b692f1306e0ce483f1ab6e3ed52b6d81a948e84d5916
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Release files / annapurna-0.2.1-py3-none-any.whl

Download URL annapurna-0.2.1-py3-none-any.whl
Size 76.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3c94428cd38ae018c5a669d6433dcfca6b7dc230e97484fcad1d53b9a4a13d29
BLAKE2b-256 checksum
How to use checksums
315706986cf5ec9a3b435f96847892c90b47233230db749db4e3ff55cb39002c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.13

Security for annapurna 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page