Getting Started

Quick start guide to set up your development environment and run your first algorithm
Installation

Install the NeuralChip SDK and dependencies. Choose your preferred package manager:

# Using npm
npm install @neuralchip/sdk

# Using pip (Python SDK)
pip install neuralchip

# Using cargo (Rust SDK)
cargo add neuralchip
Configure Your Environment

Set up your API credentials and configure the SDK:

import { NeuralChip } from '@neuralchip/sdk';

const chip = new NeuralChip({
  apiKey: process.env.NEURALCHIP_API_KEY,
  region: 'us-west-2'
});
Run Your First Algorithm

Execute a placement algorithm to place cells on a chip:

const result = await chip.placement.run({
  algorithm: 'simulated_annealing',
  chipWidth: 200,
  chipHeight: 200,
  cells: [
    { id: 'cell1', width: 10, height: 10 },
    { id: 'cell2', width: 15, height: 15 }
  ],
  iterations: 1000
});

console.log('Placement completed:', result);
Visualize Results

View and analyze your algorithm results:

// Use the web interface
// Navigate to http://localhost:3000/visualizations

// Or export results programmatically
await chip.export.toSVG(result, 'output.svg');
await chip.export.toJSON(result, 'output.json');
What's Next?
Explore Algorithm Categories

Learn about the 70+ algorithms available across 17 categories including placement, routing, floorplanning, and more.

View Algorithms
API Reference

Complete API documentation for all programming languages and interfaces.

View API Docs
Tutorials & Examples

Follow step-by-step tutorials covering common use cases and advanced scenarios.

View Tutorials
Need Help?

Join our community or contact support for assistance with setup and development.

Contact SupportBack to Docs