Skip to content

Commit 3d80fa8

Browse files
Mirko ZitkovichMirko Zitkovich
authored andcommitted
Fixed README example commands and improved project description
1 parent 330d8b9 commit 3d80fa8

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Flex Net Sim Backend API
22

3-
This is a Flask-based backend API that runs the Flex Net Sim C++ library.
3+
This is a Flask-based backend API that runs the FlexNetSim C++ library. It is an unofficial API that powers the backend for the web app deployed at [www.in-progress.com](www.in-progress.com).
44

55
## Prerequisites
66

@@ -46,14 +46,14 @@ This is a Flask-based backend API that runs the Flex Net Sim C++ library.
4646
```bash
4747
curl -X POST -H "Content-Type: application/json" \
4848
-d '{
49-
"algorithm": "BestFit",
50-
"networkType": 2,
51-
"goal_connections": 50000,
52-
"confidence": 0.01,
53-
"lambda": 1.5,
54-
"mu": 8,
55-
"network": "USNet",
56-
"bitrate": "100Gbps"
49+
"algorithm": "FirstFit",
50+
"networkType": 1, -> (Only EONs available for the moment)
51+
"goal_connections": 10000000,
52+
"confidence": 0.05,
53+
"lambda": 120,
54+
"mu": 1,
55+
"network": "NSFNet",
56+
"bitrate": "bitrate" -> (filename in the ./bitrates folder)
5757
}' \
5858
http://127.0.0.1:5000/run_simulation
5959
```

0 commit comments

Comments
 (0)