Skip to content

Commit b21d2ea

Browse files
Merge pull request #65 from N-BodyPhysicsSimulator/codex/improve-readme.md
Improve README with overview and features
2 parents 6d166ba + 69d8752 commit b21d2ea

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
11
# N-Body Physics Simulator (and Visualisator)
22
[![codecov](https://codecov.io/gh/N-BodyPhysicsSimulator/main/branch/master/graph/badge.svg)](https://codecov.io/gh/N-BodyPhysicsSimulator/main)
33
[![Build Status](https://travis-ci.org/N-BodyPhysicsSimulator/Main.svg?branch=master)](https://travis-ci.org/N-BodyPhysicsSimulator/Main)
4+
5+
A simple Python program for simulating an N-body system. The simulator
6+
can read initial states from JSON or CSV files and stream results to
7+
outputs such as CSV files or a WebSocket server. A small command line
8+
interface is provided for running experiments.
49
## Installation by `pip`
510

611
`python3 -mpip install git+git://github.com/N-BodyPhysicsSimulator/Main.git`
712

813
## To run
914

1015
`python3 -m nbp`
16+
### Features
17+
- Modular input and output system
18+
- Supports JSON and CSV input
19+
- Multiple output writers including CSV, JSON and WebSocket
20+
- Optional modifiers for calculations
1121

1222
## How to contribute
1323

0 commit comments

Comments
 (0)