Skip to content
This repository has been archived by the owner on Jul 12, 2022. It is now read-only.

Commit

Permalink
doc(nbs): update list of notebook contents
Browse files Browse the repository at this point in the history
  • Loading branch information
ankostis committed Aug 28, 2019
1 parent 86b6606 commit b0c5aba
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
9 changes: 7 additions & 2 deletions Notebooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,27 @@ Notebooks for processing UNECE's WLTP reference implementations in Python and MS

[TOC]


## Contents

- Python code implementing the WLTP algorithm (CURRENTLY PARTLY IMPLEMENTED `master` branch).
- The original files of the algo (document & MSAccess db).
- Notebooks to process the vehicle data, build HDF5-dbm launch the algo, etc::

RunVehicle.ipynb sample code to run sample vehicle data
Cycler.ipynb (WIP) run a vehicle from the h5db, step-by-step.
CarsDB-compare.ipynb compare results stored h5db with AccDb
CarsDB-msaccess.ipynb populate h5db with Heinz test-car input & output
CarsDB-pyalgo.ipynb populate h5db with results from the old python code
CarsDB-compare.ipynb print comparison results for cars in the h5db
CarsDB-cycler.ipynb (WIP) run a vehicle from the h5db, step-by-step.
HDF5-APIh-help.ipynb list usefull HDF5 methods
VMax.ipynb VMax experiments
Rounding.ipynb showcase ROUNDING across MSAccess, Python, Matlab & C#
../tests/vehdb.py support code for reading & validating vehicles from HD5 files
*.Rmd R-markdown git-tracked files paired with *.ipynb notebooks
VehData/ folder with raw input & results (e.g Heinz's msaccess DB)
+--WltpGS-msaccess.h5 the h5db storing *accdb* inputs & results
+--WltpGS-pyalgo.h5 the h5db storing *pyalgo* results
WLTP_GS_AccessDB-sources/ AccDB code & queries extracted and stored as text
binder/ configurations for launching demo in https://mybinder.org
conda/
+--environment.yaml reproduce this conda-env with: `conda create -f conda/environment.yaml`
Expand Down
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ The files and folders of the project are listed below (see also :ref:`architectu
+--docs/ ## (folder) documentation
| +--pyplots/ ## (DEPRECATED by notebooks) scripts plotting the metric diagrams embeded in the README
+--Notebooks/ ## Jupyter notebooks for running & comparing results (see `Notebooks/README.md`)
+--WLTP_GS_AccessDB-sources/ ## AccDB code & queries extracted and stored as text
+--setup.py ## (script) The entry point for `setuptools`, installing, testing, etc
+--requirements/ ## (txt-files) Various pip-dependencies for tools.
+--README.rst
Expand Down

0 comments on commit b0c5aba

Please sign in to comment.