Skip to content
Snippets Groups Projects
Commit 8265bd73 authored by BastianTigges's avatar BastianTigges
Browse files

fixed failures in API reference when make html

parent 72a3eaed
No related branches found
No related tags found
No related merge requests found
Expand all Hide whitespace changes
Inline Side-by-side
Showing
with 57 additions and 197 deletions
docs/build/doctrees/Reference/build_multi_parameters/index.doctree
+ 0
− 0
View file @ 8265bd73
No preview for this file type
docs/build/doctrees/Reference/pipeline/index.doctree
+ 0
− 0
View file @ 8265bd73
No preview for this file type
docs/build/doctrees/Reference/storage/index.doctree
+ 0
− 0
View file @ 8265bd73
No preview for this file type
docs/build/doctrees/environment.pickle
+ 0
− 0
View file @ 8265bd73
No preview for this file type
docs/build/doctrees/start/index.doctree
+ 0
− 0
View file @ 8265bd73
No preview for this file type
docs/build/doctrees/user/index.doctree
+ 0
− 0
View file @ 8265bd73
No preview for this file type
docs/build/html/Reference/index.html
+ 2
− 2
View file @ 8265bd73
......@@ -23,7 +23,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="build_multi_parameters" href="build_multi_parameters/index.html" />
<link rel="prev" title="Getting Started" href="../user/index.html" />
<link rel="prev" title="User Guide" href="../user/index.html" />
</head>
<body class="wy-body-for-nav">
......@@ -115,7 +115,7 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../user/index.html" class="btn btn-neutral float-left" title="Getting Started" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../user/index.html" class="btn btn-neutral float-left" title="User Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="build_multi_parameters/index.html" class="btn btn-neutral float-right" title="build_multi_parameters" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
......
docs/build/html/Reference/pipeline/index.html
+ 3
− 2
View file @ 8265bd73
......@@ -121,7 +121,7 @@
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – the name of the pipeline</p>
</dd>
</dl>
<p class="rubric">Examples</p>
<p class="rubric">Example</p>
<p>pipeline1 = Pipeline(‘measured/capa1/raw’)</p>
<p>pipeline1.attrs[‘variable’] = ‘voltage’</p>
<p>pipeline1.attrs[‘units’] = ‘volts’</p>
......@@ -138,7 +138,8 @@
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>TypeError</strong> – raised when the element is not the type of Instrument or Dataset</p></li>
<li><p><strong>TypeError</strong> – raised when the element is not the type of Instrument
or Dataset</p></li>
<li><p><strong>AssertionError</strong> – raised when list_obj is not a list or it is empty</p></li>
</ul>
</dd>
......
docs/build/html/_sources/Reference/build_multi_parameters/index.rst.txt
+ 1
− 1
View file @ 8265bd73
......@@ -28,7 +28,7 @@ Functions
their attributes as key value pairs
Format of dic
------------
--------------
{
"list_of_parameters":[
{
......
docs/build/html/_sources/Reference/pipeline/index.rst.txt
+ 4
− 3
View file @ 8265bd73
......@@ -30,7 +30,7 @@ Classes
:param name: the name of the pipeline
:type name: str
.. rubric:: Examples
.. rubric:: Example
pipeline1 = Pipeline('measured/capa1/raw')
......@@ -40,11 +40,11 @@ Classes
pipeline1.attrs['origin'] = 'this'
pipeline.add([dataset1, dataset2])
pipeline.add([instrument1, insturment2])
.. py:method:: add(self, list_obj)
add (multi) dataset(s) and instrument(s) into model
......@@ -52,7 +52,8 @@ Classes
:param list_obj: a list of Instrument or Dataset object(s)
:type list_obj: List[Instrument | Dataset]
:raises TypeError: raised when the element is not the type of Instrument or Dataset
:raises TypeError: raised when the element is not the type of Instrument
or Dataset
:raises AssertionError: raised when list_obj is not a list or it is empty
......
docs/build/html/_sources/Reference/storage/index.rst.txt
+ 2
− 2
View file @ 8265bd73
......@@ -141,7 +141,7 @@ Classes
Add a flat Dictionary of key values as a set of attributes.
Parameters:
-----------
------------
dict : str
The Dictionary consists of Key Value pairs
with the keys being the names of the attribute
......@@ -153,7 +153,7 @@ Classes
encode anything as a string
Parameters:
----------
-----------
object: Any
an object which can be an instance of any class
......
docs/build/html/_sources/start/index.rst.txt
+ 2
− 3
View file @ 8265bd73
......@@ -14,8 +14,7 @@ At the same time, it should be noted that the writing and tutorials of this tool
4. Install the corresponding third-party library dependencies::
4. Install PYKKN by using pip install::
conda install numpy h5py pandas
conda install -c conda-forge py-opencv
pip install pykkn
docs/build/html/_sources/user/index.rst.txt
+ 9
− 62
View file @ 8265bd73
Getting Started
User Guide
*****************
.. Start of excample project
......@@ -13,12 +13,14 @@ Setup
Let's start with a short example of how to use Pykraken (PYKKN).
First, you need to implement the following lines of code. This is mandatory for every PYKKN project you are dealing with::
from instrument import Instrument
from model import Model
from parameter import Parameter
from dataset import Dataset
from pipeline import Pipeline
from run import Run
from pykkn.dataset import Dataset
from pykkn.dataset_image import Dataset_Image
from pykkn.dataset_video import Dataset_Video
from pykkn.instrument import Instrument
from pykkn.model import Model
from pykkn.parameter import Parameter
from pykkn.pipeline import Pipeline
from pykkn.run import Run
In this case, we also import Numpy as a widely used library in Python::
......@@ -364,61 +366,6 @@ add the timestamp as metadata::
datasetVideo1.attrs['timestamp'] = '2022-06-13 11:22:11'
***********************
Dataset key value pair
***********************
.. end of the explanation of the dataset modules
.. start of the explanation of the modules to specify sensor characterisitcs
=========================================
Modules to specify sensor characteristics
=========================================
If you collected your data through a
**********
Parameter
**********
******
Model
******
**********
Instrument
**********
.. end of the explanation of the modules to specify sensor characterisitcs
.. start of the explanation of the modules to structure the data
==========================================
Modules to structure data in the hdf5 file
==========================================
*********
Pipeline
*********
****
Run
****
.. end of the explanation of the modules to structure the data
.. |br| raw:: html
<br>
\ No newline at end of file
docs/build/html/objects.inv
+ 5
− 3
View file @ 8265bd73
......@@ -2,6 +2,8 @@
# Project: PYKKN
# Version:
# The remainder of this file is compressed using zlib.
xڭn0 z
5zإŶf$wmۓL#NҒDIEm8dZ&&E (͋MGe=WYW[T|g{&o;bXlwe8YCVcE 4"Kxm@Qb+4xktD[*ϣ08%8|fffK[KуDg/,Pl t6 Bq*SȨ b=HMABi8oࣨlЮv~"/6C8
j5#kv"dH=2_es.>\AX*sl>ډuucN^9+W$qFM-U9 !CF[:O(l &Wtxx~R*(D'S셳bO(-84XVYưŌ~76{~!mZHpr%8])>pm$ڎdu[u'eQV;$a79_ͭuMAU"T 2RqXu_źw&ls3ѧS:q#z(s7&6虤y#>rn}| {f5Y莛!}9 mqq̝-N_MQŝ]ὕQw>rA(Sx_xcbǥպڿqZ(`L=+5V<?8c
\ No newline at end of file
xڭKn0<vkYt]0EW-Mb6zzkz=I)mr$;J<>$p[$i D
*2*xY`bv&MIwtElXfyF/O+Fh0ƋlgDz$#r'PǴJz| U>'.KS?_d "Et1o-_D:CcQ2#6dDLUa@`ߔ0 0ȜpU 2C|{Yj]Cv~Dpg!5 5H06Gof䝚S),d
Ri N ^p{k<zjDf1hR5n`'0@ OJlm= '95^D`e=@r
9h,y,#Cd*6v1ߍ͞m[H΀?}8+Gs sM|HV8~>,Σ*h(On~~篦6uM*o%0R_uWźw&m3S:HG񯃴1K$ͻёLvöd3A͚޷w(ЗJMqu5Sg hc_IBIv: a/B{+ hk#t2~S e*W2ژݸTԶ:o\*~ u #'P9 &jӛ E^G
\ No newline at end of file
......
docs/build/html/searchindex.js
+ 1
− 1
View file @ 8265bd73
This diff is collapsed.
docs/build/html/start/index.html
+ 4
− 5
View file @ 8265bd73
......@@ -22,7 +22,7 @@
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Getting Started" href="../user/index.html" />
<link rel="next" title="User Guide" href="../user/index.html" />
<link rel="prev" title="Welcome to PYKKN’s documentation!" href="../index.html" />
</head>
......@@ -85,9 +85,8 @@ At the same time, it should be noted that the writing and tutorials of this tool
</pre></div>
</div>
</li>
<li><p>Install the corresponding third-party library dependencies:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">install</span> <span class="n">numpy</span> <span class="n">h5py</span> <span class="n">pandas</span>
<span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">py</span><span class="o">-</span><span class="n">opencv</span>
<li><p>Install PYKKN by using pip install:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">pykkn</span>
</pre></div>
</div>
</li>
......@@ -99,7 +98,7 @@ At the same time, it should be noted that the writing and tutorials of this tool
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../index.html" class="btn btn-neutral float-left" title="Welcome to PYKKN’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../user/index.html" class="btn btn-neutral float-right" title="Getting Started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="../user/index.html" class="btn btn-neutral float-right" title="User Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
......
docs/build/html/user/index.html
+ 12
− 47
View file @ 8265bd73
......@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting Started &mdash; PYKKN 0.1 documentation</title>
<title>User Guide &mdash; PYKKN 0.1 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
......@@ -70,18 +70,6 @@
<li class="toctree-l3"><a class="reference internal" href="#dataset-module">Dataset module</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dataset-image">Dataset image</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dataset-video">Dataset video</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dataset-key-value-pair">Dataset key value pair</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#modules-to-specify-sensor-characteristics">Modules to specify sensor characteristics</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#parameter">Parameter</a></li>
<li class="toctree-l3"><a class="reference internal" href="#model">Model</a></li>
<li class="toctree-l3"><a class="reference internal" href="#instrument">Instrument</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#modules-to-structure-data-in-the-hdf5-file">Modules to structure data in the hdf5 file</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#pipeline">Pipeline</a></li>
<li class="toctree-l3"><a class="reference internal" href="#run">Run</a></li>
</ul>
</li>
</ul>
......@@ -103,7 +91,7 @@
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
<li>Getting Started</li>
<li>User Guide</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/user/index.rst.txt" rel="nofollow"> View page source</a>
</li>
......@@ -113,20 +101,22 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="getting-started">
<h1>Getting Started<a class="headerlink" href="#getting-started" title="Permalink to this headline"></a></h1>
<section id="user-guide">
<h1>User Guide<a class="headerlink" href="#user-guide" title="Permalink to this headline"></a></h1>
<section id="example-project-first-steps">
<h2>Example project first steps<a class="headerlink" href="#example-project-first-steps" title="Permalink to this headline"></a></h2>
<section id="setup">
<h3>Setup<a class="headerlink" href="#setup" title="Permalink to this headline"></a></h3>
<p>Let’s start with a short example of how to use Pykraken (PYKKN).
First, you need to implement the following lines of code. This is mandatory for every PYKKN project you are dealing with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">instrument</span> <span class="kn">import</span> <span class="n">Instrument</span>
<span class="kn">from</span> <span class="nn">model</span> <span class="kn">import</span> <span class="n">Model</span>
<span class="kn">from</span> <span class="nn">parameter</span> <span class="kn">import</span> <span class="n">Parameter</span>
<span class="kn">from</span> <span class="nn">dataset</span> <span class="kn">import</span> <span class="n">Dataset</span>
<span class="kn">from</span> <span class="nn">pipeline</span> <span class="kn">import</span> <span class="n">Pipeline</span>
<span class="kn">from</span> <span class="nn">run</span> <span class="kn">import</span> <span class="n">Run</span>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pykkn.dataset</span> <span class="kn">import</span> <span class="n">Dataset</span>
<span class="kn">from</span> <span class="nn">pykkn.dataset_image</span> <span class="kn">import</span> <span class="n">Dataset_Image</span>
<span class="kn">from</span> <span class="nn">pykkn.dataset_video</span> <span class="kn">import</span> <span class="n">Dataset_Video</span>
<span class="kn">from</span> <span class="nn">pykkn.instrument</span> <span class="kn">import</span> <span class="n">Instrument</span>
<span class="kn">from</span> <span class="nn">pykkn.model</span> <span class="kn">import</span> <span class="n">Model</span>
<span class="kn">from</span> <span class="nn">pykkn.parameter</span> <span class="kn">import</span> <span class="n">Parameter</span>
<span class="kn">from</span> <span class="nn">pykkn.pipeline</span> <span class="kn">import</span> <span class="n">Pipeline</span>
<span class="kn">from</span> <span class="nn">pykkn.run</span> <span class="kn">import</span> <span class="n">Run</span>
</pre></div>
</div>
<p>In this case, we also import Numpy as a widely used library in Python:</p>
......@@ -542,31 +532,6 @@ add the timestamp as metadata:</p>
</pre></div>
</div>
</section>
<section id="dataset-key-value-pair">
<h3>Dataset key value pair<a class="headerlink" href="#dataset-key-value-pair" title="Permalink to this headline"></a></h3>
</section>
</section>
<section id="modules-to-specify-sensor-characteristics">
<h2>Modules to specify sensor characteristics<a class="headerlink" href="#modules-to-specify-sensor-characteristics" title="Permalink to this headline"></a></h2>
<p>If you collected your data through a</p>
<section id="parameter">
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this headline"></a></h3>
</section>
<section id="model">
<h3>Model<a class="headerlink" href="#model" title="Permalink to this headline"></a></h3>
</section>
<section id="instrument">
<h3>Instrument<a class="headerlink" href="#instrument" title="Permalink to this headline"></a></h3>
</section>
</section>
<section id="modules-to-structure-data-in-the-hdf5-file">
<h2>Modules to structure data in the hdf5 file<a class="headerlink" href="#modules-to-structure-data-in-the-hdf5-file" title="Permalink to this headline"></a></h2>
<section id="pipeline">
<h3>Pipeline<a class="headerlink" href="#pipeline" title="Permalink to this headline"></a></h3>
</section>
<section id="run">
<h3>Run<a class="headerlink" href="#run" title="Permalink to this headline"></a></h3>
</section>
</section>
</section>
......
docs/source/start/index.rst
+ 2
− 3
View file @ 8265bd73
......@@ -14,8 +14,7 @@ At the same time, it should be noted that the writing and tutorials of this tool
4. Install the corresponding third-party library dependencies::
4. Install PYKKN by using pip install::
conda install numpy h5py pandas
conda install -c conda-forge py-opencv
pip install pykkn
docs/source/user/index.rst
+ 9
− 62
View file @ 8265bd73
Getting Started
User Guide
*****************
.. Start of excample project
......@@ -13,12 +13,14 @@ Setup
Let's start with a short example of how to use Pykraken (PYKKN).
First, you need to implement the following lines of code. This is mandatory for every PYKKN project you are dealing with::
from instrument import Instrument
from model import Model
from parameter import Parameter
from dataset import Dataset
from pipeline import Pipeline
from run import Run
from pykkn.dataset import Dataset
from pykkn.dataset_image import Dataset_Image
from pykkn.dataset_video import Dataset_Video
from pykkn.instrument import Instrument
from pykkn.model import Model
from pykkn.parameter import Parameter
from pykkn.pipeline import Pipeline
from pykkn.run import Run
In this case, we also import Numpy as a widely used library in Python::
......@@ -364,61 +366,6 @@ add the timestamp as metadata::
datasetVideo1.attrs['timestamp'] = '2022-06-13 11:22:11'
***********************
Dataset key value pair
***********************
.. end of the explanation of the dataset modules
.. start of the explanation of the modules to specify sensor characterisitcs
=========================================
Modules to specify sensor characteristics
=========================================
If you collected your data through a
**********
Parameter
**********
******
Model
******
**********
Instrument
**********
.. end of the explanation of the modules to specify sensor characterisitcs
.. start of the explanation of the modules to structure the data
==========================================
Modules to structure data in the hdf5 file
==========================================
*********
Pipeline
*********
****
Run
****
.. end of the explanation of the modules to structure the data
.. |br| raw:: html
<br>
\ No newline at end of file
pykkn/build_multi_parameters.py
+ 1
− 1
View file @ 8265bd73
......@@ -11,7 +11,7 @@ def build_multi_parameters(dic: dict) -> list:
their attributes as key value pairs
Format of dic
------------
--------------
{
"list_of_parameters":[
{
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment