Skip to main content

Neuracore Client Library

Project description

Neuracore Python Client

Neuracore is a powerful robotics and machine learning client library for seamless robot data collection, model deployment, and interaction.

Features

  • Easy robot initialization and connection
  • Streaming data logging
  • Model endpoint management
  • Local and remote model support
  • Flexible dataset creation

Installation

pip install neuracore

Quick Start

Ensure you have an account at (https://www.neuracore.app/)[https://www.neuracore.app/]

Authentication

import neuracore as nc

# This will save your API key locally
nc.login()

Robot Connection

# Connect to a robot
nc.connect_robot(
    robot_name="MyRobot", 
    urdf_path="/path/to/robot.urdf"
)

Data Logging

# Log joint positions
nc.log_joints({
    'joint1': 0.5, 
    'joint2': -0.3
})

# Log RGB camera image
nc.log_rgb("top_camera", image_array)

Development

To set up for development:

git clone https://github.com/neuraco/neuracore
cd neuracore
pip install -e .[dev]

Testing

export NEURACORE_API_URL=http://localhost:8000/api
pytest tests/

Contributing

Contributions are welcome!

Project details


Release history Release notifications | RSS feed

This version

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neuracore-1.0.0.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

neuracore-1.0.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file neuracore-1.0.0.tar.gz.

File metadata

  • Download URL: neuracore-1.0.0.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for neuracore-1.0.0.tar.gz
Algorithm Hash digest
SHA256 98b756f0b6d15d530d69b086331d9b07faf2f1f3733467373dfdd9fe660ec0c9
MD5 21b5237d649cfd5df213993eb8a06449
BLAKE2b-256 c8026b7502e230278159b68455f087620e5807882289ef10e1595907761aefd1

See more details on using hashes here.

File details

Details for the file neuracore-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: neuracore-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 17.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.11

File hashes

Hashes for neuracore-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 925e39a18d1dfdad4f15e14c0662fb5b12e2840be1278dcab1a1f1ed25db4cf5
MD5 8461a40f0b8b460c9dc616122e70b27d
BLAKE2b-256 65b803444f3b2707e665a9bf96d84cbb73b7413045d53008ef075ecf19157e8c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page