From e9b287ceaccc7f701af976012701c1b30118aff6 Mon Sep 17 00:00:00 2001 From: James Powell Date: Tue, 22 May 2018 11:10:06 -0400 Subject: [PATCH 1/2] small readme fix --- README.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.rst b/README.rst index ff0269ee..7f66a71f 100644 --- a/README.rst +++ b/README.rst @@ -68,6 +68,12 @@ fully-functional programs. By default, this script operates on a single span network defined in `examples/edfa/edfa_example_network.json `_ +You may need to set PYTHONPATH variable. For example on Ubuntu, add your workspace path to PYTHONPATH in your .bashrc file: + +.. code-block:: shell + + export PYTHONPATH=$PYTHONPATH:~//gnpy/ + You can specify a different network at the command line as follows. For example, to use the CORONET Continental US (CONUS) network defined in `examples/coronet_conus_example.json `_: From 9577f4c9a369cf00118dfd0ab1cdaa519d1c09d7 Mon Sep 17 00:00:00 2001 From: James Date: Tue, 21 Aug 2018 11:47:49 -0400 Subject: [PATCH 2/2] Update README.rst --- README.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7f66a71f..94a46cbb 100644 --- a/README.rst +++ b/README.rst @@ -27,6 +27,12 @@ Installation $ pip install gnpy +This will make the library available for your use. To test, try importing `gnpy` from your Python console + +.. code-block:: python + + >>> import gnpy + It can also be installed directly from the repo. .. code-block:: shell @@ -57,7 +63,7 @@ fully-functional programs. development.* -**To get started, run the transmission example:** +**To get started, perform an installation from the repo and run the transmission example:** **Note**: *Examples should be run from the examples/ folder.*