Skip to content

Commit 860ae5d

Browse files
committed
Add keywords, update installation guide
1 parent c2feef6 commit 860ae5d

File tree

3 files changed

+37
-5
lines changed

3 files changed

+37
-5
lines changed

.vscode/launch.json

+17
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,23 @@
8181
"5",
8282
"14"
8383
]
84+
},
85+
{
86+
"name": "Run: Grey Wolf Optimizer",
87+
"type": "python",
88+
"request": "launch",
89+
"module": "swarmlib",
90+
"console": "internalConsole",
91+
"args": [
92+
"--dark",
93+
"--continuous",
94+
"-i",
95+
"2000",
96+
"wolves",
97+
"-n",
98+
"30",
99+
"14"
100+
]
84101
}
85102
]
86103
}

README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,18 @@ Currently, the following algorithms are implemented:
1919

2020
## Installation
2121

22-
You can install the package with `pip` from [pypi](https://pypi.org/project/swarmlib):
22+
You can install the package with `pip` from [pypi](https://pypi.org/project/swarmlib).
23+
Installing the library in a virtual environment is recommended:
2324

24-
```
25+
```zsh
26+
# Create virtual environment
27+
python3 -m venv .venv
28+
source .venv/bin/activate
29+
30+
# Install swarmlib
2531
pip install swarmlib
2632

33+
# Verify installation
2734
swarm --version
2835
```
2936

@@ -38,10 +45,14 @@ swarm --help
3845
## Contribution
3946

4047
If you found a bug or are missing a feature do not hesitate to [file an issue](https://github.com/HaaLeo/swarmlib/issues/new/choose).
48+
Do not hesitate to ask questions on [gitter](https://gitter.im/HaaLeo/swarmlib).
49+
4150
Pull Requests are welcome!
4251

4352
## Support
44-
When you like this package make sure to [star the repository](https://github.com/HaaLeo/swarmlib/stargazers). I am always looking for new ideas and feedback.
53+
When you like this package make sure to [star the repository](https://github.com/HaaLeo/swarmlib/stargazers).
54+
I am always looking for new ideas and feedback.
55+
4556
In addition, it is possible to [donate via paypal](https://www.paypal.me/LeoHanisch/3eur).
4657

4758
## Algorithms
@@ -231,7 +242,6 @@ Currently two functions can be selected:
231242

232243
![GWO Sample](https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/gwo.gif)
233244

234-
235245
To print all available options execute:
236246

237247
```

setup.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,12 @@
7777
'colony',
7878
'ABC',
7979
'abc',
80-
'heuristic'
80+
'heuristic',
81+
'grey',
82+
'wolf',
83+
'optimizer',
84+
'gwo',
85+
'GWO'
8186
],
8287
classifiers=[
8388
'Development Status :: 5 - Production/Stable',

0 commit comments

Comments
 (0)