Skip to content

Commit

Permalink
docs: no need to cd examples first
Browse files Browse the repository at this point in the history
The code determines these paths relative to the actual example .py file
already. Given that `pytest` and other bits expect to run from the
top-levle directory, let's remove this misleading instruction from the
docs.
  • Loading branch information
jktjkt committed Jun 17, 2019
1 parent 8259124 commit e1dc3dc
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,9 @@ fully-functional programs.

**To get started, run the main transmission example:**

**Note**: *Examples should be run from the examples/ folder.*

.. code-block:: shell-session
$ pwd
/path/to/oopt-gnpy
$ cd examples
$ python transmission_main_example.py
$ ./examples/transmission_main_example.py
By default, this script operates on a single span network defined in
`examples/edfa_example_network.json <examples/edfa_example_network.json>`_
Expand All @@ -142,8 +137,7 @@ example, to use the CORONET Global network defined in

.. code-block:: shell-session
$ cd examples
$ python transmission_main_example.py CORONET_Global_Topology.json
$ ./examples/transmission_main_example.py examples/CORONET_Global_Topology.json
It is also possible to use an Excel file input (for example
`examples/CORONET_Global_Topology.xls <examples/CORONET_Global_Topology.xls>`_).
Expand Down

0 comments on commit e1dc3dc

Please sign in to comment.