Python SDK for ASTRIA — Subspace Computing Engine
Project description
Subspace Computing Engine - Python SDK
Python SDK for the Subspace Computing Engine API (by Beausoft).
Installation
pip install subspacecomputing
Usage
Initialization
from subspacecomputing import ASTRIA
# Initialize the client (defaults to production URL)
client = ASTRIA(api_key='your-api-key-here')
# For local testing or custom environments (optional)
# client = ASTRIA(api_key='your-api-key-here', base_url='http://localhost:8000')
Teams (X-Team-Id)
Keys can carry a default_team_id from the portal. If the user is in several teams, some endpoints require an explicit team: pass team_id=... or call set_team_id so the SDK sends X-Team-Id.
If you omit it when required, the API returns 400 with error.reason team_context_required. Use ValidationError and read exc.reason.
client = ASTRIA(api_key="...", team_id="00000000-0000-0000-0000-000000000000")
client.set_team_id(None) # clear override for following requests
Simple Projection (1 scenario)
# Create a simple SP Model
spec = {
'scenarios': 1, # Must be 1 for /project
'steps': 12,
'variables': [
{
'name': 'capital',
'init': 1000.0,
'formula': 'capital[t-1] * 1.05' # 5% growth per period
}
]
}
# Run the projection
result = client.project(spec)
# Display results
print(f"Final capital: {result['final_values']['capital']}")
print(f"Trajectory: {result['trajectory']['capital']}")
Monte Carlo Simulation (Multiple scenarios)
# SP Model with random variables
spec = {
'scenarios': 1000, # 1000 Monte Carlo scenarios
'steps': 12,
'variables': [
{
'name': 'taux',
'dist': 'uniform',
'params': {'min': 0.03, 'max': 0.07},
'per': 'scenario'
},
{
'name': 'capital',
'init': 1000.0,
'formula': 'capital[t-1] * (1 + taux)'
}
]
}
# Run the simulation
result = client.simulate(spec)
# Analyze results
print(f"Mean final capital: {result['last_mean']['capital']}")
print(f"Median: {result['statistics']['capital']['median']}")
print(f"P5: {result['statistics']['capital']['percentiles']['5']}")
print(f"P95: {result['statistics']['capital']['percentiles']['95']}")
Batch Mode (Multiple Entities)
# SP Model template
template = {
'scenarios': 1,
'steps': '65 - batch_params.age', # Dynamic steps
'variables': [
{
'name': 'age_actuel',
'init': 'batch_params.age'
},
{
'name': 'salaire',
'init': 'batch_params.salary',
'formula': 'salaire[t-1] * 1.03' # 3% annual increase
},
{
'name': 'capital_retraite',
'init': 0.0,
'formula': 'capital_retraite[t-1] * 1.05 + salaire[t] * 0.10'
}
]
}
# Entity data
batch_params = [
{'entity_id': 'emp_001', 'age': 45, 'salary': 60000},
{'entity_id': 'emp_002', 'age': 50, 'salary': 80000},
{'entity_id': 'emp_003', 'age': 35, 'salary': 50000}
]
# Global aggregations (optional)
aggregations = [
{
'name': 'capital_total',
'formula': 'sum(capital_retraite[t_final])'
},
{
'name': 'moyenne_capital',
'formula': 'mean(capital_retraite[t_final])'
}
]
# Run batch
result = client.project_batch(
template=template,
batch_params=batch_params,
aggregations=aggregations
)
# Analyze results
for entity in result['entities']:
print(f"{entity['_entity_id']}: Capital = {entity['final_values']['capital_retraite']}")
print(f"Total capital: {result['aggregations']['capital_total']}")
print(f"Average: {result['aggregations']['moyenne_capital']}")
Validation
# Validate an SP Model before execution
validation = client.validate(spec)
if validation['is_valid']:
print("✅ SP Model is valid")
if validation.get('warnings'):
print(f"⚠️ Warnings: {validation['warnings']}")
else:
print(f"❌ Errors: {validation['errors']}")
Utilities
# Get examples
examples = client.get_examples()
print(f"Available examples: {len(examples['examples'])}")
# Check usage
usage = client.get_usage()
print(f"Simulations used: {usage['usage']['simulations_used']}/{usage['usage']['simulations_limit']}")
# Get plans
plans = client.get_plans()
for plan in plans['plans']:
print(f"{plan['name']}: ${plan['price_monthly']}/month")
Error Handling
from subspacecomputing import (
Subspace,
SubspaceError,
QuotaExceededError,
RateLimitError,
AuthenticationError,
ValidationError,
)
try:
result = client.simulate(spec)
except QuotaExceededError as e:
print(f"Monthly quota exceeded: {e}")
except RateLimitError as e:
print(f"Rate limit exceeded: {e}")
print(f"Retry after: {e.response.headers.get('Retry-After')} seconds")
except AuthenticationError as e:
print(f"Invalid API key: {e}")
except ValidationError as e:
print(f"Validation error: {e.detail}")
except SubspaceError as e:
print(f"API error: {e}")
Rate Limit and Quota Information
After making a request, you can check your rate limit and quota status:
# Make a request
result = client.project(spec)
# Check rate limit info
rate_limit = client.get_rate_limit_info()
if rate_limit:
print(f"Rate limit: {rate_limit['remaining']}/{rate_limit['limit']} remaining")
# Check quota info
quota = client.get_quota_info()
if quota:
print(f"Quota: {quota['used']}/{quota['limit']} used, {quota['remaining']} remaining")
Documentation
Check out the full documentation at https://www.subspacecomputing.com/developer
API reference is available at https://www.subspacecomputing.com/docs
For support, reach out to contact@beausoft.ca
License
MIT License. Check the LICENSE file for details.
Copyright
© 2025 Beausoft Inc. All Rights Reserved
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file subspacecomputing-0.1.4.tar.gz.
File metadata
- Download URL: subspacecomputing-0.1.4.tar.gz
- Upload date:
- Size: 17.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd38f16eeab25d96019611c7fa809dd972390c9eab3930dbc8e8964dd0679456
|
|
| MD5 |
bec8620042a5075aa556e2e0736ed7d9
|
|
| BLAKE2b-256 |
4b4f5db2248e550d25810f8718d30bed13811c45e09870a64161863558c8f16c
|
File details
Details for the file subspacecomputing-0.1.4-py3-none-any.whl.
File metadata
- Download URL: subspacecomputing-0.1.4-py3-none-any.whl
- Upload date:
- Size: 10.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
57e41d0c6298d01e382644e1c7bda920687bda7ed0ef471775678b07fcf6655a
|
|
| MD5 |
e9b6467ce15628d754b14fe43294906f
|
|
| BLAKE2b-256 |
27ad8476bef4a9247cfc426a6fb316421e0add7064af2845369b2f0934630103
|