scottk/oopt-gnpy
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/oopt-gnpy.git synced 2025-11-22 09:05:11 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

docs: Fix Pygments highlighting

Browse Source 
This will make it possible to use this document within Sphinx without
warnings.

Change-Id: I069cdc42b451102d4e731c8d848716126b0e518a
This commit is contained in:
Jan Kundrát
2020-06-17 19:47:13 +02:00
parent c945bc40fe
commit a98e244abd
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@@ -86,14 +86,14 @@ https://conda.io/docs/user-guide/tasks/manage-environments.html)
To activate your Anaconda virtual environment, you may need to do the To activate your Anaconda virtual environment, you may need to do the
following: following:
.. code-block:: shell .. code-block:: shell-session
$ source /path/to/anaconda/bin/activate # activate Anaconda base environment $ source /path/to/anaconda/bin/activate # activate Anaconda base environment
(base) $ # note the change to the prompt (base) $ # note the change to the prompt
You can check which Anaconda environment you are using with: You can check which Anaconda environment you are using with:
.. code-block:: shell .. code-block:: shell-session
(base) $ conda env list # list all environments (base) $ conda env list # list all environments
# conda environments: # conda environments:
@@ -108,7 +108,7 @@ Anaconda's Python 3, you should see similar output as below. Your results may
be slightly different depending on your Anaconda installation path and the be slightly different depending on your Anaconda installation path and the
exact version of Python you are using. exact version of Python you are using.
.. code-block:: shell .. code-block:: shell-session
$ which python # check which Python executable is used $ which python # check which Python executable is used
/path/to/anaconda/bin/python /path/to/anaconda/bin/python
@@ -118,7 +118,7 @@ exact version of Python you are using.
From within your Anaconda Python 3 environment, you can clone the master branch From within your Anaconda Python 3 environment, you can clone the master branch
of the `gnpy` repo and install it with: of the `gnpy` repo and install it with:
.. code-block:: shell .. code-block:: shell-session
$ git clone https://github.com/Telecominfraproject/oopt-gnpy # clone the repo $ git clone https://github.com/Telecominfraproject/oopt-gnpy # clone the repo
$ cd oopt-gnpy $ cd oopt-gnpy
@@ -128,7 +128,7 @@ To test that `gnpy` was successfully installed, you can run this command. If it
executes without a ``ModuleNotFoundError``, you have successfully installed executes without a ``ModuleNotFoundError``, you have successfully installed
`gnpy`. `gnpy`.
.. code-block:: shell .. code-block:: shell-session
$ python -c 'import gnpy' # attempt to import gnpy $ python -c 'import gnpy' # attempt to import gnpy
@@ -200,7 +200,7 @@ The number of channel is computed based on ``spacing`` and ``f_min``, ``f_max``
An experimental support for Raman amplification is available: An experimental support for Raman amplification is available:
.. code-block:: shell .. code-block:: shell-session
$ gnpy-transmission-example \ $ gnpy-transmission-example \
$(gnpy-example-data)/raman_edfa_example_network.json \ $(gnpy-example-data)/raman_edfa_example_network.json \
@@ -211,7 +211,7 @@ General numeric parameters for simulaiton control are provided in the `gnpy/exam
Use ``gnpy-path-request`` to run multiple optimizations as follows: Use ``gnpy-path-request`` to run multiple optimizations as follows:
.. code-block:: shell .. code-block:: shell-session
$ gnpy-path-request -h $ gnpy-path-request -h
Usage: gnpy-path-requests [-h] [-v] [-o OUTPUT] [network_filename] [service_filename] [eqpt_filename] Usage: gnpy-path-requests [-h] [-v] [-o OUTPUT] [network_filename] [service_filename] [eqpt_filename]
@@ -220,7 +220,7 @@ The ``network_filename`` and ``service_filename`` can be an XLS or JSON file. Th
To see an example of it, run: To see an example of it, run:
.. code-block:: shell .. code-block:: shell-session
$ cd $(gnpy-example-data) $ cd $(gnpy-example-data)
$ gnpy-path-request meshTopologyExampleV2.xls meshTopologyExampleV2_services.json eqpt_config.json -o output_file.json $ gnpy-path-request meshTopologyExampleV2.xls meshTopologyExampleV2_services.json eqpt_config.json -o output_file.json