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 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"
)

You can also upload MuJoCo MJCF rather than URDF. For that, ensure you install extra dependencies: pip install neuracore[mjcf].

nc.connect_robot(
    robot_name="MyRobot", 
    mjcf_path="/path/to/robot.xml"
)

Data Logging

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

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

Documentation

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

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.4.1.tar.gz (61.5 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.4.1-py3-none-any.whl (86.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neuracore-1.4.1.tar.gz
  • Upload date:
  • Size: 61.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for neuracore-1.4.1.tar.gz
Algorithm Hash digest
SHA256 6158973ff141be1586a2aac5c4fd720c8ce445955f77a011a30d1f812908c7b6
MD5 c9682950b04565843ba7ff9c80c163b2
BLAKE2b-256 bda49eedffef03272399269cf384b6f1edaa435ca7bd20fd0eb5747102217f08

See more details on using hashes here.

File details

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

File metadata

  • Download URL: neuracore-1.4.1-py3-none-any.whl
  • Upload date:
  • Size: 86.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for neuracore-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3ffcb979b7ade4b50849b91894214ec6b5e3950ae1767e7433e0e747ce59d94
MD5 b8a26e8deb95bdadb57b4a552f7dbd8f
BLAKE2b-256 4b4b5116d5c77d8641b338c15279f7b9110d314f5ea975ec553b67f0abe450c9

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