sinusfox/Operations-Research-Tool
Archived
1
0
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update README.md #60

Merged
SinusFox merged 1 commits from bRNS98-patch-1 into main 2024-10-11 22:02:07 +00:00
Conversation 2 Commits 1 Files Changed 1
+18 -9
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 69d0898dc2 - Show all commits
README.md
+18 -9
View File
@@ -7,15 +7,15 @@ This projects aims to create a tool for easy calculation of operations research
- [Usage](#usage) - [Usage](#usage)
- [Supported problem types](#supported-problem-types) - [Supported problem types](#supported-problem-types)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Licence](#licence) - [License](#license)
- [Contact](#contact) - [Contact](#contact)
- [Troubleshooting](#troubleshooting) - [Issues](#issues)
## Features ## Features
- Export as LP (Linear Programming) - Export as LP (Linear Programming) and MPS(Mathematical Programming System)
- Measuring elapsed real time - Measuring elapsed real time
- Logging - Logging
- Solving via GLPK and HiGHS - Solving via GLPK
## Installation/Access ## Installation/Access
### Online ### Online
@@ -32,6 +32,11 @@ git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.gi
Navigate towards the folder, where the project is located on your machine via terminal. Navigate towards the folder, where the project is located on your machine via terminal.
Afterwards, execute the following command: Afterwards, execute the following command:
```Bash
npm install
```
This installs the necessary dependencies.
Next execute:
```Bash ```Bash
npm build npm build
``` ```
@@ -45,7 +50,11 @@ You can access the tool via browser on your machine. The default port is 3000.
If you can not reach the tool under [this link](http://localhost:3000), the default port is blocked and you have to check the terminal to get the correct port. If you can not reach the tool under [this link](http://localhost:3000), the default port is blocked and you have to check the terminal to get the correct port.
## Usage ## Usage
ToDo The tool provides a user-friendly interface to solve operations research problems. You can access it locally after installation or through the web interface if hosted online.
Solving a Problem
Input your model data in the boxes (constraints, variables, objective functions).
Click "Calculate" to see the results.
### Supported problem types ### Supported problem types
+ Linear + Linear
+ Mixed Integer + Mixed Integer
@@ -56,13 +65,13 @@ ToDo
3. Implement your changes 3. Implement your changes
4. Push your branch: `git push origin featurename` 4. Push your branch: `git push origin featurename`
5. Create a pull request 5. Create a pull request
# Licence # License
This project is licensed under the [MIT License](https://github.com/Spaceholder-Programming/Operations-Research-Tool?tab=MIT-1-ov-file). This project is licensed under the [MPL-2.0 License](https://github.com/Spaceholder-Programming/Operations-Research-Tool?tab=MPL-2.0-1-ov-file).
# Contact # Contact
If you have the desire to contact the team behind this project, use the contact details on our GitHub accounts: If you have the desire to contact the team behind this project, use the contact details on our GitHub accounts:
+ [bRNS98](https://github.com/bRNS98) + [bRNS98](https://github.com/bRNS98)
+ [moebiusl](https://github.com/moebiusl) + [moebiusl](https://github.com/moebiusl)
+ [SinusFox](https://github.com/SinusFox) + [SinusFox](https://github.com/SinusFox)
+ [widepoeppihappy](https://github.com/widepoeppihappy) + [widepoeppihappy](https://github.com/widepoeppihappy)
# Troubleshooting # Issues
If you find bug, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new). If you encounter a bug, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new).