Skip to content

Commit

Permalink
[docs] add argcomplete to list of requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
cassiotbatista committed Nov 8, 2020
1 parent 019349e commit b0ca7cc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ wavelength assignment (RWA) problem over wavelength-division multiplexing
(WDM)-based all-optical networks with static traffic (SLE, for static lightpath
establishment).

Documentation: https://rwa-wdm.readthedocs.io/en/latest/index.html
:pencil: Documentation: https://rwa-wdm.readthedocs.io/en/latest/index.html

The following algorithms are implemented:

Expand All @@ -26,12 +26,13 @@ allocated call remains in the network occupying resources) that follow the
Poisson distribution. This model was ported from a [Matlab toolbox written by
Przemyslaw Pawelcza](https://la.mathworks.com/matlabcentral/fileexchange/4797-wdm-network-blocking-computation-toolbox).


## Installation

Directly from PyPI via pip:

```bash
$ pip install rwa_wdm
$ pip install rwa-wdm
```

Or, from source:
Expand All @@ -42,6 +43,7 @@ $ cd rwa-wdm-sim/
$ python setup.py install --skip-build
```


## Usage

As a module from CLI:
Expand All @@ -55,27 +57,29 @@ $ python -m rwa_wdm -t rnp -c 8 -r dijkstra -w first-fit -d /tmp/results -p
Alternatively, as a lib:

```python
from rwa_wdm import simulator
# TBD
```


## Requirements

:warning: manual installation of required packages is necessary only if you're
:warning: Manual installation of required packages is necessary only if you're
debugging the source without properly installing the package via either PyPI or
`setuptools`.

We recommend the use of [Anaconda](https://www.anaconda.com/):

```bash
$ conda create --name rwa python=3.8 networkx numpy matplotlib
$ conda create --name rwa python=3.8 argcomplete networkx numpy matplotlib
$ conda activate rwa
```

However, you can of course just use pip as well:

```bash
$ pip install pip --upgrade
$ pip install numpy matplotlib networkx
$ pip install argcomplete numpy matplotlib networkx
```

Or simply use the `requirements.txt` file:
Expand All @@ -84,6 +88,7 @@ Or simply use the `requirements.txt` file:
$ pip install -r requirements.txt
```


## Citation

If you use this code, please cite us as one of the following:
Expand Down Expand Up @@ -138,6 +143,7 @@ If you use this code, please cite us as one of the following:
}
```


## License

GPL v3.0
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
argcomplete==1.12.1
matplotlib==3.3.2
networkx==2.5
numpy==1.19.3
argcomplete==1.12.1

0 comments on commit b0ca7cc

Please sign in to comment.