Skip to content

Commit 1c51449

Browse files
committed
Update README with notebook instructions and modify .dockerignore; refactor MRN update processing
1 parent 0bd5ce6 commit 1c51449

4 files changed

Lines changed: 131 additions & 403 deletions

File tree

.dockerignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ LICENSE.md
33
note.txt
44
images/
55
ldlib_mrn/
6-
mrn_notebook/
6+
mrn_notebook/
7+
src/OMMStream-MRN-LD.ipynb

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,42 @@ It is an advisable to create a dedicate Python environment to run each Python pr
131131

132132
$src>
133133
```
134+
135+
### How to run this a Notebook example
136+
137+
The project contain both console console application *src/OMMStream-MRN-LD.py* and Jupyter Notebook *src/OMMStream-MRN-LD.ipynb*. In order to run the Notebook example, please follows the steps below.
138+
139+
1. Open the ```src/lseg_data.config.json``` file and add your RTO or RTDS information based on your preference like the suggestion on above section.
140+
2. Open a command prompt application and go to the project folder
141+
3. Run the following command in a command prompt to create a new Python virtual environment named *notebook* for the project (the name can be changed based on your preference).
142+
143+
```bash
144+
$ python -m venv notebook
145+
```
146+
4. Once the environment creation is succeed, activate a virtual environment with the following command.
147+
148+
```bash
149+
#Windows
150+
$ notebook\Scripts\activate
151+
152+
#Linux
153+
$ source notebook/bin/activate
154+
155+
#success
156+
(notebook)$
157+
```
158+
5. Run the following command to install the Notebook dependencies in virtual environment.
159+
160+
```bash
161+
(notebook)$ pip install -r requirements-notebook.txt
162+
```
163+
164+
6. To run a Notebook application run the ```jupyter lab``` command while the ```notebook``` environment is activated, and open the *src/OMMStream-MRN-LD.ipynb* file.
165+
166+
```bash
167+
(notebook)$ jupyter lab
168+
```
169+
134170
### Note about the Virtual Environment
135171

136172
If you are using the [Anaconda](https://anaconda.org/anaconda/conda)/[Miniconda](https://docs.anaconda.com/miniconda/) Python distribution, please refer to the [Conda document](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) about how to create a virtual environment using Conda.

0 commit comments

Comments
 (0)