<commit_before>elevatorsim
===========

elevatorsim is an elevator simulator written in Javascript.

Why a simulator for elevators?
---
Valid question! At the place I work we have elevators, as with many workplaces. However from time to time they seem to make stupid decisions that causes frustration for people waiting. This has caused a discussion to arise regarding how hard it could be to write a decent elevator software. After many weeks of thinking about this issue I decided to put together a basic simulator to be able to try this out.

More information?
---
I will write more in this readme when I get the inspiration.

Setup
---
* Clone repo
* npm install

How to run
---
```
./main.js 
Usage: node ./main.js

Examples:
  node ./main.js --ai=simple --scenario=scenario1    Run the simulation with the default options


Options:
  -a, --ai          Select an AI to use                      [required]
  -s, --scenario    Select a scenario to run                 [required]
  -l, --logger      Select a logger to use                   [required]
  -r, --randomseed  Random seed to use for seeded scenarios
```

Examples:
```
./main.js --ai=ai/simple.js --scenario=scenario/scenario1.js --logger=logger/console.js --randomseed=123
```

License
---
MIT<commit_msg>Add test instructions to readme<commit_after>elevatorsim
===========

elevatorsim is an elevator simulator written in Javascript.

Why a simulator for elevators?
---
Valid question! At the place I work we have elevators, as with many workplaces. However from time to time they seem to make stupid decisions that causes frustration for people waiting. This has caused a discussion to arise regarding how hard it could be to write a decent elevator software. After many weeks of thinking about this issue I decided to put together a basic simulator to be able to try this out.

More information?
---
I will write more in this readme when I get the inspiration.

Setup
---
* Clone repo
* npm install

How to run
---
```
./main.js 
Usage: node ./main.js

Examples:
  node ./main.js --ai=simple --scenario=scenario1    Run the simulation with the default options


Options:
  -a, --ai          Select an AI to use                      [required]
  -s, --scenario    Select a scenario to run                 [required]
  -l, --logger      Select a logger to use                   [required]
  -r, --randomseed  Random seed to use for seeded scenarios
```

Examples:
```
./main.js --ai=ai/simple.js --scenario=scenario/scenario1.js --logger=logger/console.js --randomseed=123
```

How to run tests
---
```
npm test
```

License
---
MIT
{'fraction_non_alphanumeric': 0.09195844555598306, 'fraction_numerical': 0.003847633705271258, 'mean_word_length': 2.7463976945244957, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '842752', 'n_tokens_mistral': 738, 'n_tokens_neox': 694, 'n_words': 343}