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

Commit

Permalink
fic9doc): sphinx :mod: needs absolute package in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ankostis committed Aug 28, 2019
1 parent a1e42a7 commit 4be5fad
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ For information on the accepted model-data, check the :ref:`code:Schema`:
...


You then have to feed this model-tree to the :class:`~.wltp.experiment.Experiment`
You then have to feed this model-tree to the :class:`~wltp.experiment.Experiment`
constructor. Internally the :class:`pandalone.pandel.Pandel` resolves URIs, fills-in default values and
validates the data based on the project's pre-defined :term:`JSON-schema`:

Expand Down Expand Up @@ -540,7 +540,7 @@ till that point.

It is composed by a stack of mergeable `JSON-schema` abiding trees of *string, numbers & pandas objects*,
formed with python *sequences & dictionaries, and URI-references*.
It is implemented in :mod:`~.datamodel`, supported by :class:`pandalone.pandata.Pandel`.
It is implemented in :mod:`~wltp.datamodel`, supported by :class:`pandalone.pandata.Pandel`.


WOT
Expand All @@ -553,18 +553,18 @@ till that point.
Grid WOTs
A dataframe produced from `WOT` for all gear-ratios, indexed by a grid of rounded velocities,
and with 2-level columns ``(item, gear)``.
It is generated by :func:`~.engine.interpolate_wot_on_v_grid()`, and augmented
by :func:`~.engine.calc_p_avail_in_gwots()` & :func:`~.vehicle.calc_road_load_power()` .
It is generated by :func:`~wltp.engine.interpolate_wot_on_v_grid()`, and augmented
by :func:`~wltp.engine.calc_p_avail_in_gwots()` & :func:`~wltp.vehicle.calc_road_load_power()` .

.. TODO::
Move `Grid WOTs` code in own module :mod:`~.gwots`.
Move `Grid WOTs` code in own module :mod:`~wltp.gwots`.

cycle
Cycle run
A dataframe with all the time-series, indexed by the time of the samples.
The velocities for each time-sample must exist in the `gwots`.
The columns are the same 2-level columns like *gwots*.
it is implemented in :mod:`~.cycler`.
it is implemented in :mod:`~wltp.cycler`.

Code Structure:
---------------
Expand All @@ -575,19 +575,19 @@ The computation code is roughly divided in these python modules:
formulae
Physics and engineering code, implemented in modules:

- :mod:`~.engine`
- :mod:`~.vmax`
- :mod:`~.downscale`
- :mod:`~.vehicle`
- :mod:`~wltp.engine`
- :mod:`~wltp.vmax`
- :mod:`~wltp.downscale`
- :mod:`~wltp.vehicle`

- orchestration
The code producing the actual gear-shifting, implemented in modules:

- :mod:`~.datamodel`
- :mod:`~.cycler`
- :mod:`~.gridwots` (TODO)
- :mod:`~.scheduler` (TODO)
- :mod:`~.experiment` (TO BE DROPPED, :mod:`~.datamodel` will assume all functionality)
- :mod:`~wltp.datamodel`
- :mod:`~wltp.cycler`
- :mod:`~wltp.gridwots` (TODO)
- :mod:`~wltp.scheduler` (TODO)
- :mod:`~wltp.experiment` (TO BE DROPPED, :mod:`~wltp.datamodel` will assume all functionality)

scheduler
(TODO) The internal software component which decides which `formulae` to execute
Expand Down

0 comments on commit 4be5fad

Please sign in to comment.