Installation

Prerequisites

Before installing Discrete-Sim, ensure you have:

• Node.js version 16.0 or higher
• npm or yarn package manager
• TypeScript 5.0+ (recommended for type safety)

Package Installation

Using npm

npm install discrete-sim

Using yarn

yarn add discrete-sim

Using pnpm

pnpm add discrete-sim

Import Methods

ES Modules (Recommended)

import { Simulation, Resource, timeout } from 'discrete-sim';

CommonJS

const { Simulation, Resource, timeout } = require('discrete-sim');

TypeScript Support

Discrete-Sim is written in TypeScript and includes type definitions out of the box. No additional @types package is needed.

import { Simulation, Resource, timeout } from 'discrete-sim';

const sim: Simulation = new Simulation();
const server: Resource = new Resource(sim, 1);

TypeScript Configuration

For optimal TypeScript support, ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "moduleResolution": "node",
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "target": "ES2020",
    "module": "ESNext"
  }
}

Development Setup

If you want to contribute or modify Discrete-Sim:

1. Clone the repository

git clone https://github.com/anesask/discrete-sim.git
cd discrete-sim

2. Install dependencies

npm install

3. Build the library

npm run build

4. Run tests

npm test

5. Link for local development

npm link

# In your project
npm link discrete-sim

Bundler Configuration

Webpack

No special configuration needed. Discrete-Sim works out of the box with Webpack 5.

// webpack.config.js
module.exports = {
  // Your configuration
};

Vite

// vite.config.js
import { defineConfig } from 'vite';

export default defineConfig({
  // Discrete-Sim works without any special config
});

Rollup

// rollup.config.js
import resolve from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs';

export default {
  input: 'src/main.js',
  plugins: [
    resolve(),
    commonjs()
  ],
  // Your configuration
};

Verifying Installation

After installation, verify everything is working:

import { Simulation } from 'discrete-sim';

const sim = new Simulation();
console.log('Simulation created:', sim);
console.log('Current time:', sim.now); // Should output: 0

Package Structure

After installation, the package structure includes:

node_modules/discrete-sim/
├── dist/
│   ├── index.js         # CommonJS build
│   ├── index.mjs        # ES modules build
│   └── index.d.ts       # TypeScript definitions
├── package.json
├── README.md
└── LICENSE

Environment Support

Discrete-Sim is designed for Node.js environments:

• Node.js 16+ (required)
• TypeScript 5.0+ (recommended)
• Works with any Node.js-compatible environment (Electron, etc.)

Next Steps

Now that you have Discrete-Sim installed, proceed to:

• Quick Start - Build your first simulation
• Core Concepts - Understand the fundamental concepts
• API Reference - Explore the complete API