Skip to content

Commit e1dc3dc

Browse files
committed
docs: no need to cd examples first
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.
1 parent 8259124 commit e1dc3dc

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

README.rst

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -124,14 +124,9 @@ fully-functional programs.
124124

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

127-
**Note**: *Examples should be run from the examples/ folder.*
128-
129127
.. code-block:: shell-session
130128
131-
$ pwd
132-
/path/to/oopt-gnpy
133-
$ cd examples
134-
$ python transmission_main_example.py
129+
$ ./examples/transmission_main_example.py
135130
136131
By default, this script operates on a single span network defined in
137132
`examples/edfa_example_network.json <examples/edfa_example_network.json>`_
@@ -142,8 +137,7 @@ example, to use the CORONET Global network defined in
142137

143138
.. code-block:: shell-session
144139
145-
$ cd examples
146-
$ python transmission_main_example.py CORONET_Global_Topology.json
140+
$ ./examples/transmission_main_example.py examples/CORONET_Global_Topology.json
147141
148142
It is also possible to use an Excel file input (for example
149143
`examples/CORONET_Global_Topology.xls <examples/CORONET_Global_Topology.xls>`_).

0 commit comments

Comments
 (0)